diff --git a/onos-a1t/README.md b/onos-a1t/README.md new file mode 100644 index 0000000..ad73806 --- /dev/null +++ b/onos-a1t/README.md @@ -0,0 +1,29 @@ + + +# onos-a1t +A1 AP Termination module for ONOS SD-RAN (µONOS Architecture) + +## Overview +The `onos-a1t` is the A1 termination node in the near-RT RIC for A1 interface to communicate the near-RT RIC with the non-RT RIC. +It is the proxy that forwards incoming A1 messages from the non-RT RIC to appropriate xApps or outgoing A1 messages from xApps to the non-RT RIC. +As per the O-RAN Working Group 2 specification, `onos-a1t` should support A1 messages for (i) the policy management, (ii) the enrichment information, and (iii) the machine learning model management. +As of today, since the O-RAN A1 specification only defines the policy management data model, `onos-a1t` only supports the policy management service. + +Regarding O-RAN specifications, `onos-a1t` supports A1 Application Protocol v03.01 and A1 Type Definitions v02.00. + +## Interaction +The `onos-a1t` interacts with at least three nodes: (i) `onos-topo`, (ii) `A1-enabled xApps` and (iii) `non-RT RIC`. +To begin with, `onos-a1t` keeps listening the `onos-topo` to check if there is new `A1-enabled xApps` deployed and if there are `A1-enabled xApps` already running. +Basically, the A1-enabled `xApps` initially stores its A1 interface information, such as supported A1 services (i.e., the policy management, the enrichment information, and the machine learning model management) and A1 interface endpoint (i.e., IP address and port number). +Listening `onos-topo`, `onos-a1t` scrapes the A1 interface information and store it into the `onos-a1t` local store. +With the A1 interface information, `onos-a1t` starts creating the gRPC session with appropriate xApps to communicate with each other. +A gRPC server is the `A1-enabled xApp`, whereas `onos-a1t` acts as the gRPC client (Note that this design is able to support the high availability and reliability by using the replicas for the near future). +In order to communicate with the non-RT RIC, `onos-a1t` has both an HTTP server and an HTTP client. +And of course, the non-RT RIC has to have both the HTTP server and the HTTP client for the bi-directional communication over HTTP. +The HTTP server in `onos-a1t` receives the JSON formatted A1 interface message from the non-RT RIC. +The HTTP client in `onos-a1t` is the client that sends the JSON formatted outgoing A1 interface messages to the non-RT RIC. +The HTTP client and server implementations are auto generated from the OpenAPI definitions provided by the A1 Application Protocol specifications. \ No newline at end of file diff --git a/onos-api/README.md b/onos-api/README.md new file mode 100644 index 0000000..40b325b --- /dev/null +++ b/onos-api/README.md @@ -0,0 +1,49 @@ + + +# onos-api +gRPC API definitions for the µONOS platform + +## Overview +This repository houses not only the `.proto` files, but also a number of automatically generated artifacts, e.g. `.pb.go`, `.py` files and similarly for other languages that may be added in the future. + +The source tree structure is paritioned into `proto`, which contains the canonical protobuf definitions and a top-level directory for each of the supported languages. The structure within each of the language-specific directories reflects the idoms and conventions appropriate to each language. + +## Proto +The top-level package for the protobuf definitions is `onos` and the next level subpackage is the name of the particular platform subsystem, such as `config`, `topo`, etc. This directory tree should contain exclusively the `.proto` files and not be tainted by any other artifacts, especially any language-specific ones. + +The proto files are compiled and processed via `build/bin/compile-protos.sh` script, which is invoked by the `Makefile`. All protofiles here should follow the established guidelines and must pass the protobuf lint checker enforcing these conventions. + +## Golang +The `go` source tree holds the automatically-generated `.pb.go` artifacts and also any manually authored `.go` source files written in support of the Golang bindings. To minimize the churn and to exercise tighter control over versioning, the generated files are also versioned and maintained in the SCM repo. + +The root package of the module is `github.com/onosproject/onos-api/go/onos`, with subpackages being named after each of the platform subsystems, mirroring the structure of the `proto` packages. Golang projects that wish to import µONOS API packages should include the following in the requirements section of their `go.mod` file: + +```go +require ( + ... + github.com/onosproject/onos-api/go v0.6.1 + ... +) + +``` + +Additionally, Go bindings are generated with mocks for testing with [gomock]. Mocks of Protobuf interfaces can be constructed via the same package as the interfaces they mock: + +```go +import topoapi "github.com/onosproject/onos-api/go/onos/topo" +... +mockClient := topoapi.NewMockTopoClient(ctrl) +``` + +## Python + +The `python` source tree holds gRPC bindings are generated for [Python]. Pyhton bindings are generated with the [python-betterproto] protoc plugin and support Python3's `asyncio` framework. + +[gomock]: https://github.com/golang/mock +[Go]: https://golang.org/ +[Protobuf]: https://developers.google.com/protocol-buffers +[Python]: https://www.python.org +[python-betterproto]: https://github.com/danielgtaylor/python-betterproto diff --git a/onos-api/docs/onos/a1t/a1.md b/onos-api/docs/onos/a1t/a1.md new file mode 100644 index 0000000..737df38 --- /dev/null +++ b/onos-api/docs/onos/a1t/a1.md @@ -0,0 +1,201 @@ +# Protocol Documentation + + +## Table of Contents + +- [onos/a1t/admin/admin.proto](#onos_a1t_admin_admin-proto) + - [GetPolicyObjectRequest](#onos-a1t-admin-GetPolicyObjectRequest) + - [GetPolicyObjectResponse](#onos-a1t-admin-GetPolicyObjectResponse) + - [GetPolicyObjectStatusRequest](#onos-a1t-admin-GetPolicyObjectStatusRequest) + - [GetPolicyObjectStatusResponse](#onos-a1t-admin-GetPolicyObjectStatusResponse) + - [GetPolicyTypeObjectRequest](#onos-a1t-admin-GetPolicyTypeObjectRequest) + - [GetPolicyTypeObjectResponse](#onos-a1t-admin-GetPolicyTypeObjectResponse) + - [GetXAppConnectionResponse](#onos-a1t-admin-GetXAppConnectionResponse) + - [GetXAppConnectionsRequest](#onos-a1t-admin-GetXAppConnectionsRequest) + + - [A1TAdminService](#onos-a1t-admin-A1TAdminService) + +- [Scalar Value Types](#scalar-value-types) + + + + +
+ +## onos/a1t/admin/admin.proto + + + + + +### GetPolicyObjectRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| policy_type_id | [string](#string) | | | +| policy_object_id | [string](#string) | | | + + + + + + + + +### GetPolicyObjectResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| policy_type_id | [string](#string) | | | +| policy_object_id | [string](#string) | | | +| policy_object | [string](#string) | | | + + + + + + + + +### GetPolicyObjectStatusRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| policy_type_id | [string](#string) | | | +| policy_object_id | [string](#string) | | | + + + + + + + + +### GetPolicyObjectStatusResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| policy_type_id | [string](#string) | | | +| policy_object_id | [string](#string) | | | +| policy_object_status | [string](#string) | | | + + + + + + + + +### GetPolicyTypeObjectRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| policy_type_id | [string](#string) | | | + + + + + + + + +### GetPolicyTypeObjectResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| policy_type_id | [string](#string) | | | +| policy_ids | [string](#string) | repeated | | +| policy_type_object | [string](#string) | | | + + + + + + + + +### GetXAppConnectionResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| xapp_id | [string](#string) | | | +| supported_a1_service | [string](#string) | | | +| supported_a1_service_type_id | [string](#string) | | | +| xapp_a1_endpoint | [string](#string) | | | + + + + + + + + +### GetXAppConnectionsRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| xapp_id | [string](#string) | | | + + + + + + + + + + + + + + +### A1TAdminService + + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| GetXAppConnections | [GetXAppConnectionsRequest](#onos-a1t-admin-GetXAppConnectionsRequest) | [GetXAppConnectionResponse](#onos-a1t-admin-GetXAppConnectionResponse) stream | GetXAppConnections | +| GetPolicyTypeObject | [GetPolicyTypeObjectRequest](#onos-a1t-admin-GetPolicyTypeObjectRequest) | [GetPolicyTypeObjectResponse](#onos-a1t-admin-GetPolicyTypeObjectResponse) stream | GetPolicyTypeObject | +| GetPolicyObject | [GetPolicyObjectRequest](#onos-a1t-admin-GetPolicyObjectRequest) | [GetPolicyObjectResponse](#onos-a1t-admin-GetPolicyObjectResponse) stream | GetPolicyObject | +| GetPolicyObjectStatus | [GetPolicyObjectStatusRequest](#onos-a1t-admin-GetPolicyObjectStatusRequest) | [GetPolicyObjectStatusResponse](#onos-a1t-admin-GetPolicyObjectStatusResponse) stream | GetPolicyObjectStatus | + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | 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 | int32 | int | integer | Bignum or Fixnum (as required) | +| 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 | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/onos-api/docs/onos/config/admin.md b/onos-api/docs/onos/config/admin.md new file mode 100644 index 0000000..14da166 --- /dev/null +++ b/onos-api/docs/onos/config/admin.md @@ -0,0 +1,690 @@ +# Protocol Documentation + + +## Table of Contents + +- [onos/config/admin/admin.proto](#onos_config_admin_admin-proto) + - [GetConfigurationRequest](#onos-config-admin-GetConfigurationRequest) + - [GetConfigurationResponse](#onos-config-admin-GetConfigurationResponse) + - [GetTransactionRequest](#onos-config-admin-GetTransactionRequest) + - [GetTransactionResponse](#onos-config-admin-GetTransactionResponse) + - [LeafSelectionQueryRequest](#onos-config-admin-LeafSelectionQueryRequest) + - [LeafSelectionQueryResponse](#onos-config-admin-LeafSelectionQueryResponse) + - [ListConfigurationsRequest](#onos-config-admin-ListConfigurationsRequest) + - [ListConfigurationsResponse](#onos-config-admin-ListConfigurationsResponse) + - [ListModelsRequest](#onos-config-admin-ListModelsRequest) + - [ListTransactionsRequest](#onos-config-admin-ListTransactionsRequest) + - [ListTransactionsResponse](#onos-config-admin-ListTransactionsResponse) + - [ModelInfo](#onos-config-admin-ModelInfo) + - [ModelInfoRequest](#onos-config-admin-ModelInfoRequest) + - [ModelInfoResponse](#onos-config-admin-ModelInfoResponse) + - [ModelPlugin](#onos-config-admin-ModelPlugin) + - [Namespace](#onos-config-admin-Namespace) + - [PathValuesRequest](#onos-config-admin-PathValuesRequest) + - [PathValuesResponse](#onos-config-admin-PathValuesResponse) + - [ReadOnlyPath](#onos-config-admin-ReadOnlyPath) + - [ReadOnlySubPath](#onos-config-admin-ReadOnlySubPath) + - [ReadWritePath](#onos-config-admin-ReadWritePath) + - [RollbackRequest](#onos-config-admin-RollbackRequest) + - [RollbackResponse](#onos-config-admin-RollbackResponse) + - [ValidateConfigChunkRequest](#onos-config-admin-ValidateConfigChunkRequest) + - [ValidateConfigRequest](#onos-config-admin-ValidateConfigRequest) + - [ValidateConfigRequestChunk](#onos-config-admin-ValidateConfigRequestChunk) + - [ValidateConfigResponse](#onos-config-admin-ValidateConfigResponse) + - [ValueSelectionRequest](#onos-config-admin-ValueSelectionRequest) + - [ValueSelectionRequestChunk](#onos-config-admin-ValueSelectionRequestChunk) + - [ValueSelectionResponse](#onos-config-admin-ValueSelectionResponse) + - [WatchConfigurationsRequest](#onos-config-admin-WatchConfigurationsRequest) + - [WatchConfigurationsResponse](#onos-config-admin-WatchConfigurationsResponse) + - [WatchTransactionsRequest](#onos-config-admin-WatchTransactionsRequest) + - [WatchTransactionsResponse](#onos-config-admin-WatchTransactionsResponse) + + - [ConfigAdminService](#onos-config-admin-ConfigAdminService) + - [ConfigurationService](#onos-config-admin-ConfigurationService) + - [ModelPluginService](#onos-config-admin-ModelPluginService) + - [TransactionService](#onos-config-admin-TransactionService) + +- [Scalar Value Types](#scalar-value-types) + + + + + + +## onos/config/admin/admin.proto + + + + + +### GetConfigurationRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| configuration_id | [string](#string) | | | + + + + + + + + +### GetConfigurationResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| configuration | [onos.config.v2.Configuration](#onos-config-v2-Configuration) | | | + + + + + + + + +### GetTransactionRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | ID of transaction to get | +| index | [uint64](#uint64) | | index of transaction to get; leave 0 for lookup by ID; if specified takes precedence | + + + + + + + + +### GetTransactionResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| transaction | [onos.config.v2.Transaction](#onos-config-v2-Transaction) | | | + + + + + + + + +### LeafSelectionQueryRequest +LeafSelectionQueryRequest carries request for the selection of leaf values + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| target | [string](#string) | | target is the name of the target (device) to perform the query on | +| type | [string](#string) | | type of model plugin to perform the query on | +| version | [string](#string) | | version of model plugin to perform the query on | +| selectionPath | [string](#string) | | selectionPath is a configuration path to a leaf in the format: /a/b[key1=index][key2=index2]/c/d where d is a leaf node | +| changeContext | [gnmi.SetRequest](#gnmi-SetRequest) | | changeContext is the set of changes (e.g. from the GUI form) that have to be superimposed on the current configuration before the leaf selection can be made All the changes in this request should match the target given above optional | + + + + + + + + +### LeafSelectionQueryResponse +LeafSelectionQueryResponse carries response for the model information query + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| selection | [string](#string) | repeated | selection is an array of string values | + + + + + + + + +### ListConfigurationsRequest + + + + + + + + + +### ListConfigurationsResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| configuration | [onos.config.v2.Configuration](#onos-config-v2-Configuration) | | | + + + + + + + + +### ListModelsRequest +ListModelsRequest carries data for querying registered model plugins. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| verbose | [bool](#bool) | | verbose option causes all of the ReadWrite and ReadOnly paths to be included. | +| model_name | [string](#string) | | An optional filter on the name of the model plugins to list. | +| model_version | [string](#string) | | An optional filter on the version of the model plugins to list | + + + + + + + + +### ListTransactionsRequest + + + + + + + + + +### ListTransactionsResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| transaction | [onos.config.v2.Transaction](#onos-config-v2-Transaction) | | | + + + + + + + + +### ModelInfo +ModelInfo is general information about a model plugin. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | name is the name given to the model plugin - no spaces and title case. | +| version | [string](#string) | | version is the semantic version of the Plugin e.g. 1.0.0. | +| model_data | [gnmi.ModelData](#gnmi-ModelData) | repeated | model_data is a set of metadata about the YANG files that went in to generating the model plugin. It includes name, version and organization for each YANG file, similar to how they are represented in gNMI Capabilities. | +| module | [string](#string) | | **Deprecated.** module is no longer used | +| getStateMode | [uint32](#uint32) | | getStateMode is flag that defines how the "get state" operation works. 0) means that no retrieval of state is attempted 1) means that the synchronizer will make 2 requests to the device - one for Get with State and another for Get with Operational. 2) means that the synchronizer will do a Get request comprising of each one of the ReadOnlyPaths and their sub paths. If there is a `list` in any one of these paths it will be sent down as is, expecting the devices implementation of gNMI will be able to expand wildcards. 3) means that the synchronizer will do a Get request comprising of each one of the ReadOnlyPaths and their sub paths. If there is a `list` in any one of these paths, a separate call will be made first to find all the instances in the list and a Get including these expanded wildcards will be sent down to the device. | +| read_only_path | [ReadOnlyPath](#onos-config-admin-ReadOnlyPath) | repeated | read_only_path is all of the read only paths for the model plugin. | +| read_write_path | [ReadWritePath](#onos-config-admin-ReadWritePath) | repeated | read_write_path is all of the read write paths for the model plugin. | +| supported_encodings | [gnmi.Encoding](#gnmi-Encoding) | repeated | | +| namespace_mappings | [Namespace](#onos-config-admin-Namespace) | repeated | namespace_mappings is a set of all prefix to module name mapping in the model | +| southboundUsePrefix | [bool](#bool) | | southboundUsePrefix indicates that the southbound should add prefixes in gNMI paths | + + + + + + + + +### ModelInfoRequest +ModelInfoRequest carries request for the model information + + + + + + + + +### ModelInfoResponse +ModelInfoResponse carries response for the model information query + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| modelInfo | [ModelInfo](#onos-config-admin-ModelInfo) | | | + + + + + + + + +### ModelPlugin + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | | +| endpoint | [string](#string) | | | +| info | [ModelInfo](#onos-config-admin-ModelInfo) | | | +| status | [string](#string) | | | +| error | [string](#string) | | | + + + + + + + + +### Namespace +Namespace is a mapping between a module name and its shorthand prefix + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| module | [string](#string) | | | +| prefix | [string](#string) | | | + + + + + + + + +### PathValuesRequest +PathValuesRequest carries configuration change as a JSON blob + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| pathPrefix | [string](#string) | | | +| json | [bytes](#bytes) | | | + + + + + + + + +### PathValuesResponse +PathValuesResponse carries a list of typed path values + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| pathValues | [onos.config.v2.PathValue](#onos-config-v2-PathValue) | repeated | | + + + + + + + + +### ReadOnlyPath +ReadOnlyPath extracted from the model plugin as the definition of a tree of read only items. +In YANG models items are defined as ReadOnly with the `config false` keyword. +This can be applied to single items (leafs) or collections (containers or lists). +When this `config false` is applied to an object every item beneath it will +also become readonly - here these are shown as subpaths. +The complete read only path then will be a concatenation of both e.g. +/cont1a/cont1b-state/list2b/index and the type is defined in the SubPath as UInt8. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| path | [string](#string) | | path of the topmost `config false` object e.g. /cont1a/cont1b-state | +| sub_path | [ReadOnlySubPath](#onos-config-admin-ReadOnlySubPath) | repeated | ReadOnlySubPath is a set of children of the path including an entry for the type of the topmost object with subpath `/` An example is /list2b/index | + + + + + + + + +### ReadOnlySubPath +ReadOnlySubPath is an extension to the ReadOnlyPath to define the datatype of +the subpath + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| sub_path | [string](#string) | | sub_path is the relative path of a child object e.g. /list2b/index | +| value_type | [onos.config.v2.ValueType](#onos-config-v2-ValueType) | | value_type is the datatype of the read only path | +| type_opts | [uint64](#uint64) | repeated | | +| description | [string](#string) | | | +| units | [string](#string) | | | +| IsAKey | [bool](#bool) | | | +| AttrName | [string](#string) | | | + + + + + + + + +### ReadWritePath +ReadWritePath is extracted from the model plugin as the definition of a writeable attributes. +In YANG models items are writable by default unless they are specified as `config false` or +have an item with `config false` as a parent. +Each configurable item has metadata with meanings taken from the YANG specification RFC 6020. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| path | [string](#string) | | path is the full path to the attribute (leaf or leaf-list) | +| value_type | [onos.config.v2.ValueType](#onos-config-v2-ValueType) | | value_type is the data type of the attribute | +| units | [string](#string) | | units is the unit of measurement e.g. dB, mV | +| description | [string](#string) | | description is an explaination of the meaning of the attribute | +| mandatory | [bool](#bool) | | mandatory shows whether the attribute is optional (false) or required (true) | +| default | [string](#string) | | **Deprecated.** default is a default value used with optional attributes. Replaced by 'defaults' below | +| range | [string](#string) | repeated | range is definition of the range of values a value is allowed | +| length | [string](#string) | repeated | length is a defintion of the length restrictions for the attribute | +| type_opts | [uint64](#uint64) | repeated | | +| IsAKey | [bool](#bool) | | | +| AttrName | [string](#string) | | | +| defaults | [string](#string) | repeated | defaults is a default value(s) used with optional attributes. For leaf-list can have repeated values replaces the 'default' attribute above | + + + + + + + + +### RollbackRequest +RollbackRequest carries the index of the configuration change transaction to rollback. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| index | [uint64](#uint64) | | index of the transaction that should be rolled back | + + + + + + + + +### RollbackResponse +RollbackResponse carries the response of the rollback operation + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | ID of the rollback transaction | +| index | [uint64](#uint64) | | index of the rollback transaction | + + + + + + + + +### ValidateConfigChunkRequest +ValidateConfigRequest carries configuration data to be validated as a JSON blob + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| json | [bytes](#bytes) | | | + + + + + + + + +### ValidateConfigRequest +ValidateConfigRequest carries configuration data to be validated as a JSON blob + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| json | [bytes](#bytes) | | | + + + + + + + + +### ValidateConfigRequestChunk +ValidateConfigRequestChunk carries configuration data to be validated as a JSON blob +Recommended maximum size is 100kB + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| json | [bytes](#bytes) | | | + + + + + + + + +### ValidateConfigResponse +ValidateConfigResponse carries the result of the validation + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| valid | [bool](#bool) | | | +| message | [string](#string) | | | + + + + + + + + +### ValueSelectionRequest +ValueSelectionRequest carries the necessary parts to form a selection context + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| selectionPath | [string](#string) | | selectionPath is a configuration path to a leaf in the format: /a/b[key1=index][key2=index2]/c/d where d is a leaf node | +| configJson | [bytes](#bytes) | | configJson is a JSON tree view of the complete Configuration for a Target | + + + + + + + + +### ValueSelectionRequestChunk +ValueSelectionRequestChunk carries the necessary parts to form a selection context +Recommended maximum size is 100kB + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| selectionPath | [string](#string) | | selectionPath is a configuration path to a leaf in the format: /a/b[key1=index][key2=index2]/c/d where d is a leaf node | +| configJson | [bytes](#bytes) | | configJson is a JSON tree view of the complete Configuration for a Target | + + + + + + + + +### ValueSelectionResponse +ValueSelectionResponse returns the result of applying the selection rules to the selection context + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| selection | [string](#string) | repeated | selection is an array of string values | + + + + + + + + +### WatchConfigurationsRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| configuration_id | [string](#string) | | | +| noreplay | [bool](#bool) | | | + + + + + + + + +### WatchConfigurationsResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| event | [onos.config.v2.ConfigurationEvent](#onos-config-v2-ConfigurationEvent) | | | + + + + + + + + +### WatchTransactionsRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | | +| noreplay | [bool](#bool) | | | + + + + + + + + +### WatchTransactionsResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| event | [onos.config.v2.TransactionEvent](#onos-config-v2-TransactionEvent) | | | + + + + + + + + + + + + + + +### ConfigAdminService +ConfigAdminService provides means for enhanced interactions with the configuration subsystem. + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| ListRegisteredModels | [ListModelsRequest](#onos-config-admin-ListModelsRequest) | [ModelPlugin](#onos-config-admin-ModelPlugin) stream | ListRegisteredModels returns a stream of registered models. | +| RollbackTransaction | [RollbackRequest](#onos-config-admin-RollbackRequest) | [RollbackResponse](#onos-config-admin-RollbackResponse) | RollbackTransaction rolls back the specified configuration change transaction. | +| LeafSelectionQuery | [LeafSelectionQueryRequest](#onos-config-admin-LeafSelectionQueryRequest) | [LeafSelectionQueryResponse](#onos-config-admin-LeafSelectionQueryResponse) | LeafSelectionQuery selects values allowable for leaf. It supports the ROC GUI by supplying a list of valid leaf values based off an XPath query defined in a 'leaf-selection' YANG extension Calls on GetValueSelection RPC on Model Plugin | + + + + +### ConfigurationService +ConfigurationService provides means to inspect the contents of the internal configurations store. + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| GetConfiguration | [GetConfigurationRequest](#onos-config-admin-GetConfigurationRequest) | [GetConfigurationResponse](#onos-config-admin-GetConfigurationResponse) | Get configuration by its target ID | +| ListConfigurations | [ListConfigurationsRequest](#onos-config-admin-ListConfigurationsRequest) | [ListConfigurationsResponse](#onos-config-admin-ListConfigurationsResponse) stream | List returns all target configurations | +| WatchConfigurations | [WatchConfigurationsRequest](#onos-config-admin-WatchConfigurationsRequest) | [WatchConfigurationsResponse](#onos-config-admin-WatchConfigurationsResponse) stream | Watch returns a stream of configuration change notifications | + + + + +### ModelPluginService +ModelPluginService is to be implemented by model plugin sidecar + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| GetModelInfo | [ModelInfoRequest](#onos-config-admin-ModelInfoRequest) | [ModelInfoResponse](#onos-config-admin-ModelInfoResponse) | GetModelInfo provides information about the model | +| ValidateConfig | [ValidateConfigRequest](#onos-config-admin-ValidateConfigRequest) | [ValidateConfigResponse](#onos-config-admin-ValidateConfigResponse) | ValidateConfig validates the provided configuration data against the model | +| ValidateConfigChunked | [ValidateConfigRequestChunk](#onos-config-admin-ValidateConfigRequestChunk) stream | [ValidateConfigResponse](#onos-config-admin-ValidateConfigResponse) | ValidateConfigChunked validates the provided configuration data against the model | +| GetPathValues | [PathValuesRequest](#onos-config-admin-PathValuesRequest) | [PathValuesResponse](#onos-config-admin-PathValuesResponse) | GetPathValues produces list of typed path value entries from the specified configuration change JSON tree | +| GetValueSelection | [ValueSelectionRequest](#onos-config-admin-ValueSelectionRequest) | [ValueSelectionResponse](#onos-config-admin-ValueSelectionResponse) | GetValueSelection gets a list of valid options for a leaf by applying selection rules in YANG. Replaced by GetValueSelectionChunked | +| GetValueSelectionChunked | [ValueSelectionRequestChunk](#onos-config-admin-ValueSelectionRequestChunk) stream | [ValueSelectionResponse](#onos-config-admin-ValueSelectionResponse) | GetValueSelectionChunked gets a list of valid options for a leaf by applying selection rules in YANG. The selection rules should be defined as an XPath expression, as an argument to a `leaf-selection` extension in the YANG model (Used to support the ROC GUI) | + + + + +### TransactionService +TransactionService provides means to inspect the contents of the internal transactions store. + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| GetTransaction | [GetTransactionRequest](#onos-config-admin-GetTransactionRequest) | [GetTransactionResponse](#onos-config-admin-GetTransactionResponse) | Get transaction by its ID or index | +| ListTransactions | [ListTransactionsRequest](#onos-config-admin-ListTransactionsRequest) | [ListTransactionsResponse](#onos-config-admin-ListTransactionsResponse) stream | List returns all configuration transactions | +| WatchTransactions | [WatchTransactionsRequest](#onos-config-admin-WatchTransactionsRequest) | [WatchTransactionsResponse](#onos-config-admin-WatchTransactionsResponse) stream | Watch returns a stream of configuration transaction change notifications | + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | 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 | int32 | int | integer | Bignum or Fixnum (as required) | +| 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 | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/onos-api/docs/onos/config/v2/configuration.md b/onos-api/docs/onos/config/v2/configuration.md new file mode 100644 index 0000000..e520179 --- /dev/null +++ b/onos-api/docs/onos/config/v2/configuration.md @@ -0,0 +1,239 @@ +# Protocol Documentation + + +## Table of Contents + +- [onos/config/v2/configuration.proto](#onos_config_v2_configuration-proto) + - [AppliedConfigurationStatus](#onos-config-v2-AppliedConfigurationStatus) + - [AppliedConfigurationStatus.ValuesEntry](#onos-config-v2-AppliedConfigurationStatus-ValuesEntry) + - [CommittedConfigurationStatus](#onos-config-v2-CommittedConfigurationStatus) + - [Configuration](#onos-config-v2-Configuration) + - [Configuration.ValuesEntry](#onos-config-v2-Configuration-ValuesEntry) + - [ConfigurationEvent](#onos-config-v2-ConfigurationEvent) + - [ConfigurationStatus](#onos-config-v2-ConfigurationStatus) + - [MastershipInfo](#onos-config-v2-MastershipInfo) + - [ProposedConfigurationStatus](#onos-config-v2-ProposedConfigurationStatus) + + - [ConfigurationEvent.EventType](#onos-config-v2-ConfigurationEvent-EventType) + - [ConfigurationStatus.State](#onos-config-v2-ConfigurationStatus-State) + +- [Scalar Value Types](#scalar-value-types) + + + + + + +## onos/config/v2/configuration.proto + + + + + +### AppliedConfigurationStatus + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| index | [uint64](#uint64) | | | +| mastership | [MastershipInfo](#onos-config-v2-MastershipInfo) | | | +| values | [AppliedConfigurationStatus.ValuesEntry](#onos-config-v2-AppliedConfigurationStatus-ValuesEntry) | repeated | | + + + + + + + + +### AppliedConfigurationStatus.ValuesEntry + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [PathValue](#onos-config-v2-PathValue) | | | + + + + + + + + +### CommittedConfigurationStatus + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| index | [uint64](#uint64) | | | + + + + + + + + +### Configuration +Configuration represents complete desired target configuration + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| meta | [ObjectMeta](#onos-config-v2-ObjectMeta) | | | +| id | [string](#string) | | 'id' is a unique configuration identifier | +| target_id | [string](#string) | | 'target_id' is the target to which the desired target configuration applies | +| values | [Configuration.ValuesEntry](#onos-config-v2-Configuration-ValuesEntry) | repeated | 'values' is a map of path/values to set | +| index | [uint64](#uint64) | | 'index' is the index of the configuration values | +| status | [ConfigurationStatus](#onos-config-v2-ConfigurationStatus) | | 'ConfigurationStatus' is the current lifecycle status of the configuration | +| target_info | [TargetTypeVersion](#onos-config-v2-TargetTypeVersion) | | | + + + + + + + + +### Configuration.ValuesEntry + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [PathValue](#onos-config-v2-PathValue) | | | + + + + + + + + +### ConfigurationEvent +ConfigurationEvent configuration store event + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| type | [ConfigurationEvent.EventType](#onos-config-v2-ConfigurationEvent-EventType) | | EventType configuration event type | +| configuration | [Configuration](#onos-config-v2-Configuration) | | | + + + + + + + + +### ConfigurationStatus +ConfigurationStatus is the status of a Configuration + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| state | [ConfigurationStatus.State](#onos-config-v2-ConfigurationStatus-State) | | 'state' is the configuration state | +| mastership | [MastershipInfo](#onos-config-v2-MastershipInfo) | | 'mastership' is the current mastership info for the configuration | +| proposed | [ProposedConfigurationStatus](#onos-config-v2-ProposedConfigurationStatus) | | 'proposed' is the proposed configuration status | +| committed | [CommittedConfigurationStatus](#onos-config-v2-CommittedConfigurationStatus) | | 'committed' is the committed configuration status | +| applied | [AppliedConfigurationStatus](#onos-config-v2-AppliedConfigurationStatus) | | 'applied' is the applied configuration status | + + + + + + + + +### MastershipInfo + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| master | [string](#string) | | | +| term | [uint64](#uint64) | | | + + + + + + + + +### ProposedConfigurationStatus + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| index | [uint64](#uint64) | | | + + + + + + + + + + +### ConfigurationEvent.EventType +EventType configuration event types for configuration store + +| Name | Number | Description | +| ---- | ------ | ----------- | +| UNKNOWN | 0 | UNKNOWN indicates unknown configuration store event | +| CREATED | 1 | CREATED indicates the configuration entry in the store is created | +| UPDATED | 2 | UPDATED indicates the configuration entry in the store is updated | +| DELETED | 3 | DELETED indicates the configuration entry in the store is deleted | +| REPLAYED | 4 | REPLAYED | + + + + + +### ConfigurationStatus.State +State is the configuration state + +| Name | Number | Description | +| ---- | ------ | ----------- | +| UNKNOWN | 0 | | +| SYNCHRONIZING | 1 | | +| SYNCHRONIZED | 2 | | +| PERSISTED | 3 | | + + + + + + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | 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 | int32 | int | integer | Bignum or Fixnum (as required) | +| 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 | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/onos-api/docs/onos/config/v2/extensions.md b/onos-api/docs/onos/config/v2/extensions.md new file mode 100644 index 0000000..80b58b9 --- /dev/null +++ b/onos-api/docs/onos/config/v2/extensions.md @@ -0,0 +1,65 @@ +# Protocol Documentation + + +## Table of Contents + +- [onos/config/v2/extensions.proto](#onos/config/v2/extensions.proto) + - [TransactionInfo](#onos.config.v2.TransactionInfo) + +- [Scalar Value Types](#scalar-value-types) + + + + + + +## onos/config/v2/extensions.proto + + + + + +### TransactionInfo +TransactionInfo is an extension providing information about the transaction +to clients in responses. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | | +| index | [uint64](#uint64) | | | + + + + + + + + + + + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | 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 | int32 | int | integer | Bignum or Fixnum (as required) | +| 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 | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/onos-api/docs/onos/config/v2/proposal.md b/onos-api/docs/onos/config/v2/proposal.md new file mode 100644 index 0000000..9f9d584 --- /dev/null +++ b/onos-api/docs/onos/config/v2/proposal.md @@ -0,0 +1,382 @@ +# Protocol Documentation + + +## Table of Contents + +- [onos/config/v2/proposal.proto](#onos_config_v2_proposal-proto) + - [ChangeProposal](#onos-config-v2-ChangeProposal) + - [ChangeProposal.ValuesEntry](#onos-config-v2-ChangeProposal-ValuesEntry) + - [Proposal](#onos-config-v2-Proposal) + - [ProposalAbortPhase](#onos-config-v2-ProposalAbortPhase) + - [ProposalApplyPhase](#onos-config-v2-ProposalApplyPhase) + - [ProposalCommitPhase](#onos-config-v2-ProposalCommitPhase) + - [ProposalEvent](#onos-config-v2-ProposalEvent) + - [ProposalInitializePhase](#onos-config-v2-ProposalInitializePhase) + - [ProposalPhaseStatus](#onos-config-v2-ProposalPhaseStatus) + - [ProposalPhases](#onos-config-v2-ProposalPhases) + - [ProposalStatus](#onos-config-v2-ProposalStatus) + - [ProposalStatus.RollbackValuesEntry](#onos-config-v2-ProposalStatus-RollbackValuesEntry) + - [ProposalValidatePhase](#onos-config-v2-ProposalValidatePhase) + - [RollbackProposal](#onos-config-v2-RollbackProposal) + + - [ProposalAbortPhase.State](#onos-config-v2-ProposalAbortPhase-State) + - [ProposalApplyPhase.State](#onos-config-v2-ProposalApplyPhase-State) + - [ProposalCommitPhase.State](#onos-config-v2-ProposalCommitPhase-State) + - [ProposalEvent.EventType](#onos-config-v2-ProposalEvent-EventType) + - [ProposalInitializePhase.State](#onos-config-v2-ProposalInitializePhase-State) + - [ProposalValidatePhase.State](#onos-config-v2-ProposalValidatePhase-State) + +- [Scalar Value Types](#scalar-value-types) + + + + + + +## onos/config/v2/proposal.proto + + + + + +### ChangeProposal + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| values | [ChangeProposal.ValuesEntry](#onos-config-v2-ChangeProposal-ValuesEntry) | repeated | 'changes' is the proposed change values | + + + + + + + + +### ChangeProposal.ValuesEntry + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [PathValue](#onos-config-v2-PathValue) | | | + + + + + + + + +### Proposal + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| meta | [ObjectMeta](#onos-config-v2-ObjectMeta) | | | +| id | [string](#string) | | 'id' is the unique identifier of the proposal | +| target_id | [string](#string) | | 'target_id' is the proposal's target identifier | +| transaction_index | [uint64](#uint64) | | 'transaction_index' is the unique index of the transaction | +| change | [ChangeProposal](#onos-config-v2-ChangeProposal) | | | +| rollback | [RollbackProposal](#onos-config-v2-RollbackProposal) | | | +| status | [ProposalStatus](#onos-config-v2-ProposalStatus) | | 'status' is the current lifecycle status of the proposal | +| target_info | [TargetTypeVersion](#onos-config-v2-TargetTypeVersion) | | | + + + + + + + + +### ProposalAbortPhase + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| status | [ProposalPhaseStatus](#onos-config-v2-ProposalPhaseStatus) | | | +| state | [ProposalAbortPhase.State](#onos-config-v2-ProposalAbortPhase-State) | | | + + + + + + + + +### ProposalApplyPhase + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| status | [ProposalPhaseStatus](#onos-config-v2-ProposalPhaseStatus) | | | +| state | [ProposalApplyPhase.State](#onos-config-v2-ProposalApplyPhase-State) | | | +| term | [uint64](#uint64) | | | +| failure | [Failure](#onos-config-v2-Failure) | | | + + + + + + + + +### ProposalCommitPhase + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| status | [ProposalPhaseStatus](#onos-config-v2-ProposalPhaseStatus) | | | +| state | [ProposalCommitPhase.State](#onos-config-v2-ProposalCommitPhase-State) | | | + + + + + + + + +### ProposalEvent +ProposalEvent proposal store event + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| type | [ProposalEvent.EventType](#onos-config-v2-ProposalEvent-EventType) | | | +| proposal | [Proposal](#onos-config-v2-Proposal) | | | + + + + + + + + +### ProposalInitializePhase + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| status | [ProposalPhaseStatus](#onos-config-v2-ProposalPhaseStatus) | | | +| state | [ProposalInitializePhase.State](#onos-config-v2-ProposalInitializePhase-State) | | | + + + + + + + + +### ProposalPhaseStatus + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| start | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | | +| end | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | | + + + + + + + + +### ProposalPhases + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| initialize | [ProposalInitializePhase](#onos-config-v2-ProposalInitializePhase) | | 'initialize' is the proposal initialization phase status | +| validate | [ProposalValidatePhase](#onos-config-v2-ProposalValidatePhase) | | 'validate' is the proposal validation phase status | +| commit | [ProposalCommitPhase](#onos-config-v2-ProposalCommitPhase) | | 'commit' is the proposal commit phase status | +| apply | [ProposalApplyPhase](#onos-config-v2-ProposalApplyPhase) | | 'apply' is the proposal apply phase status | +| abort | [ProposalAbortPhase](#onos-config-v2-ProposalAbortPhase) | | 'abort' is the proposal abort phase status | + + + + + + + + +### ProposalStatus +ProposalStatus is the status of a Proposal + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| phases | [ProposalPhases](#onos-config-v2-ProposalPhases) | | 'phases' is the proposal phases | +| prev_index | [uint64](#uint64) | | 'prev_index' is the index of the previous proposal associated with this target | +| next_index | [uint64](#uint64) | | 'next_index' is the index of the next proposal associated with this target | +| rollback_index | [uint64](#uint64) | | 'rollback_index' is a reference to the index to which to roll back | +| rollback_values | [ProposalStatus.RollbackValuesEntry](#onos-config-v2-ProposalStatus-RollbackValuesEntry) | repeated | 'rollback_values' is the set of values to use to roll back the proposal | + + + + + + + + +### ProposalStatus.RollbackValuesEntry + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [PathValue](#onos-config-v2-PathValue) | | | + + + + + + + + +### ProposalValidatePhase + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| status | [ProposalPhaseStatus](#onos-config-v2-ProposalPhaseStatus) | | | +| state | [ProposalValidatePhase.State](#onos-config-v2-ProposalValidatePhase-State) | | | +| failure | [Failure](#onos-config-v2-Failure) | | | + + + + + + + + +### RollbackProposal + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| rollback_index | [uint64](#uint64) | | 'rollback_index' is the index of the transaction to roll back | + + + + + + + + + + +### ProposalAbortPhase.State + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| ABORTING | 0 | | +| ABORTED | 1 | | + + + + + +### ProposalApplyPhase.State + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| APPLYING | 0 | | +| APPLIED | 1 | | +| FAILED | 2 | | + + + + + +### ProposalCommitPhase.State + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| COMMITTING | 0 | | +| COMMITTED | 1 | | + + + + + +### ProposalEvent.EventType +EventType proposal event types for proposal store + +| Name | Number | Description | +| ---- | ------ | ----------- | +| UNKNOWN | 0 | | +| CREATED | 1 | | +| UPDATED | 2 | | +| DELETED | 3 | | +| REPLAYED | 4 | | + + + + + +### ProposalInitializePhase.State + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| INITIALIZING | 0 | | +| INITIALIZED | 1 | | + + + + + +### ProposalValidatePhase.State + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| VALIDATING | 0 | | +| VALIDATED | 1 | | +| FAILED | 2 | | + + + + + + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | 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 | int32 | int | integer | Bignum or Fixnum (as required) | +| 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 | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/onos-api/docs/onos/config/v2/transaction.md b/onos-api/docs/onos/config/v2/transaction.md new file mode 100644 index 0000000..c1ba0ab --- /dev/null +++ b/onos-api/docs/onos/config/v2/transaction.md @@ -0,0 +1,476 @@ +# Protocol Documentation + + +## Table of Contents + +- [onos/config/v2/transaction.proto](#onos_config_v2_transaction-proto) + - [ChangeTransaction](#onos-config-v2-ChangeTransaction) + - [ChangeTransaction.ValuesEntry](#onos-config-v2-ChangeTransaction-ValuesEntry) + - [RollbackTransaction](#onos-config-v2-RollbackTransaction) + - [TargetVersionOverrides](#onos-config-v2-TargetVersionOverrides) + - [TargetVersionOverrides.OverridesEntry](#onos-config-v2-TargetVersionOverrides-OverridesEntry) + - [Transaction](#onos-config-v2-Transaction) + - [TransactionAbortPhase](#onos-config-v2-TransactionAbortPhase) + - [TransactionApplyPhase](#onos-config-v2-TransactionApplyPhase) + - [TransactionCommitPhase](#onos-config-v2-TransactionCommitPhase) + - [TransactionEvent](#onos-config-v2-TransactionEvent) + - [TransactionInfo](#onos-config-v2-TransactionInfo) + - [TransactionInitializePhase](#onos-config-v2-TransactionInitializePhase) + - [TransactionPhaseStatus](#onos-config-v2-TransactionPhaseStatus) + - [TransactionPhases](#onos-config-v2-TransactionPhases) + - [TransactionStatus](#onos-config-v2-TransactionStatus) + - [TransactionStrategy](#onos-config-v2-TransactionStrategy) + - [TransactionValidatePhase](#onos-config-v2-TransactionValidatePhase) + + - [TransactionAbortPhase.State](#onos-config-v2-TransactionAbortPhase-State) + - [TransactionApplyPhase.State](#onos-config-v2-TransactionApplyPhase-State) + - [TransactionCommitPhase.State](#onos-config-v2-TransactionCommitPhase-State) + - [TransactionEvent.EventType](#onos-config-v2-TransactionEvent-EventType) + - [TransactionInitializePhase.State](#onos-config-v2-TransactionInitializePhase-State) + - [TransactionStatus.State](#onos-config-v2-TransactionStatus-State) + - [TransactionStrategy.Isolation](#onos-config-v2-TransactionStrategy-Isolation) + - [TransactionStrategy.Synchronicity](#onos-config-v2-TransactionStrategy-Synchronicity) + - [TransactionValidatePhase.State](#onos-config-v2-TransactionValidatePhase-State) + +- [Scalar Value Types](#scalar-value-types) + + + + + + +## onos/config/v2/transaction.proto + + + + + +### ChangeTransaction + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| values | [ChangeTransaction.ValuesEntry](#onos-config-v2-ChangeTransaction-ValuesEntry) | repeated | 'values' is a set of changes to apply to targets | + + + + + + + + +### ChangeTransaction.ValuesEntry + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [PathValues](#onos-config-v2-PathValues) | | | + + + + + + + + +### RollbackTransaction + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| rollback_index | [uint64](#uint64) | | 'rollback_index' is the index of the transaction to roll back | + + + + + + + + +### TargetVersionOverrides +TargetVersionOverrides carries optional mappings of targets to their model type and version overrides. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| overrides | [TargetVersionOverrides.OverridesEntry](#onos-config-v2-TargetVersionOverrides-OverridesEntry) | repeated | | + + + + + + + + +### TargetVersionOverrides.OverridesEntry + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [TargetTypeVersion](#onos-config-v2-TargetTypeVersion) | | | + + + + + + + + +### Transaction +Transaction refers to a transaction change or transaction rollback + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| meta | [ObjectMeta](#onos-config-v2-ObjectMeta) | | | +| id | [string](#string) | | 'id' is the unique identifier of the transaction This field should be set prior to persisting the object. | +| index | [uint64](#uint64) | | 'index' is a monotonically increasing, globally unique index of the change The index is provided by the store, is static and unique for each unique change identifier, and should not be modified by client code. | +| username | [string](#string) | | 'username' is the name of the user that made the transaction | +| strategy | [TransactionStrategy](#onos-config-v2-TransactionStrategy) | | 'strategy' is the transaction strategy | +| change | [ChangeTransaction](#onos-config-v2-ChangeTransaction) | | | +| rollback | [RollbackTransaction](#onos-config-v2-RollbackTransaction) | | | +| status | [TransactionStatus](#onos-config-v2-TransactionStatus) | | 'status' is the current lifecycle status of the transaction | +| version_overrides | [TargetVersionOverrides](#onos-config-v2-TargetVersionOverrides) | | Optional target type/version overrides. | + + + + + + + + +### TransactionAbortPhase + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| status | [TransactionPhaseStatus](#onos-config-v2-TransactionPhaseStatus) | | | +| state | [TransactionAbortPhase.State](#onos-config-v2-TransactionAbortPhase-State) | | | + + + + + + + + +### TransactionApplyPhase + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| status | [TransactionPhaseStatus](#onos-config-v2-TransactionPhaseStatus) | | | +| state | [TransactionApplyPhase.State](#onos-config-v2-TransactionApplyPhase-State) | | | +| failure | [Failure](#onos-config-v2-Failure) | | | + + + + + + + + +### TransactionCommitPhase + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| status | [TransactionPhaseStatus](#onos-config-v2-TransactionPhaseStatus) | | | +| state | [TransactionCommitPhase.State](#onos-config-v2-TransactionCommitPhase-State) | | | + + + + + + + + +### TransactionEvent +TransactionEvent transaction store event + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| type | [TransactionEvent.EventType](#onos-config-v2-TransactionEvent-EventType) | | | +| transaction | [Transaction](#onos-config-v2-Transaction) | | | + + + + + + + + +### TransactionInfo +TransactionInfo is an extension providing information about the transaction +to clients in responses. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | | +| index | [uint64](#uint64) | | | + + + + + + + + +### TransactionInitializePhase + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| status | [TransactionPhaseStatus](#onos-config-v2-TransactionPhaseStatus) | | | +| state | [TransactionInitializePhase.State](#onos-config-v2-TransactionInitializePhase-State) | | | +| failure | [Failure](#onos-config-v2-Failure) | | | + + + + + + + + +### TransactionPhaseStatus + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| start | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | | +| end | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | | + + + + + + + + +### TransactionPhases + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| initialize | [TransactionInitializePhase](#onos-config-v2-TransactionInitializePhase) | | 'initialize' is the transaction initialization phase status | +| validate | [TransactionValidatePhase](#onos-config-v2-TransactionValidatePhase) | | 'validate' is the transaction validation phase status | +| commit | [TransactionCommitPhase](#onos-config-v2-TransactionCommitPhase) | | 'commit' is the transaction commit phase status | +| apply | [TransactionApplyPhase](#onos-config-v2-TransactionApplyPhase) | | 'apply' is the transaction apply phase status | +| abort | [TransactionAbortPhase](#onos-config-v2-TransactionAbortPhase) | | 'abort' is the transaction abort phase status | + + + + + + + + +### TransactionStatus + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| phases | [TransactionPhases](#onos-config-v2-TransactionPhases) | | 'phases' is the transaction phases | +| proposals | [string](#string) | repeated | 'proposals' is the set of proposals managed by the transaction | +| state | [TransactionStatus.State](#onos-config-v2-TransactionStatus-State) | | 'state' is the overall transaction state | +| failure | [Failure](#onos-config-v2-Failure) | | 'failure' is the transaction failure (if any) | + + + + + + + + +### TransactionStrategy + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| synchronicity | [TransactionStrategy.Synchronicity](#onos-config-v2-TransactionStrategy-Synchronicity) | | 'synchronicity' indicates the transaction synchronicity level | +| isolation | [TransactionStrategy.Isolation](#onos-config-v2-TransactionStrategy-Isolation) | | 'isolation' indicates the transaction isolation level | + + + + + + + + +### TransactionValidatePhase + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| status | [TransactionPhaseStatus](#onos-config-v2-TransactionPhaseStatus) | | | +| state | [TransactionValidatePhase.State](#onos-config-v2-TransactionValidatePhase-State) | | | +| failure | [Failure](#onos-config-v2-Failure) | | | + + + + + + + + + + +### TransactionAbortPhase.State + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| ABORTING | 0 | | +| ABORTED | 1 | | + + + + + +### TransactionApplyPhase.State + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| APPLYING | 0 | | +| APPLIED | 1 | | +| FAILED | 2 | | + + + + + +### TransactionCommitPhase.State + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| COMMITTING | 0 | | +| COMMITTED | 1 | | + + + + + +### TransactionEvent.EventType +EventType transaction event types for transaction store + +| Name | Number | Description | +| ---- | ------ | ----------- | +| UNKNOWN | 0 | | +| CREATED | 1 | | +| UPDATED | 2 | | +| DELETED | 3 | | +| REPLAYED | 4 | | + + + + + +### TransactionInitializePhase.State + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| INITIALIZING | 0 | | +| INITIALIZED | 1 | | +| FAILED | 2 | | + + + + + +### TransactionStatus.State + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| PENDING | 0 | | +| VALIDATED | 1 | | +| COMMITTED | 2 | | +| APPLIED | 3 | | +| FAILED | 4 | | + + + + + +### TransactionStrategy.Isolation + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| DEFAULT | 0 | | +| SERIALIZABLE | 1 | | + + + + + +### TransactionStrategy.Synchronicity + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| ASYNCHRONOUS | 0 | | +| SYNCHRONOUS | 1 | | + + + + + +### TransactionValidatePhase.State + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| VALIDATING | 0 | | +| VALIDATED | 1 | | +| FAILED | 2 | | + + + + + + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | 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 | int32 | int | integer | Bignum or Fixnum (as required) | +| 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 | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/onos-api/docs/onos/config/v2/value.md b/onos-api/docs/onos/config/v2/value.md new file mode 100644 index 0000000..fc0d8c1 --- /dev/null +++ b/onos-api/docs/onos/config/v2/value.md @@ -0,0 +1,146 @@ +# Protocol Documentation + + +## Table of Contents + +- [onos/config/v2/value.proto](#onos_config_v2_value-proto) + - [PathValue](#onos-config-v2-PathValue) + - [PathValues](#onos-config-v2-PathValues) + - [PathValues.ValuesEntry](#onos-config-v2-PathValues-ValuesEntry) + - [TypedValue](#onos-config-v2-TypedValue) + + - [ValueType](#onos-config-v2-ValueType) + +- [Scalar Value Types](#scalar-value-types) + + + + + + +## onos/config/v2/value.proto + + + + + +### PathValue +PathValue is the state of a path/value in the configuration tree + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| path | [string](#string) | | 'path' is the path to change | +| value | [TypedValue](#onos-config-v2-TypedValue) | | 'value' is the change value | +| deleted | [bool](#bool) | | 'deleted' indicates whether this is a delete | +| index | [uint64](#uint64) | | index transaction index | + + + + + + + + +### PathValues +PathValues is a set of path/value pairs + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| values | [PathValues.ValuesEntry](#onos-config-v2-PathValues-ValuesEntry) | repeated | 'values' is a set of change values to apply | + + + + + + + + +### PathValues.ValuesEntry + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [PathValue](#onos-config-v2-PathValue) | | | + + + + + + + + +### TypedValue +TypedValue is a value represented as a byte array + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| bytes | [bytes](#bytes) | | 'bytes' is the bytes array | +| type | [ValueType](#onos-config-v2-ValueType) | | 'type' is the value type | +| type_opts | [int32](#int32) | repeated | 'type_opts' is a set of type options | + + + + + + + + + + +### ValueType +ValueType is the type for a value + +| Name | Number | Description | +| ---- | ------ | ----------- | +| EMPTY | 0 | | +| STRING | 1 | | +| INT | 2 | | +| UINT | 3 | | +| BOOL | 4 | | +| DECIMAL | 5 | | +| FLOAT | 6 | | +| BYTES | 7 | | +| LEAFLIST_STRING | 8 | | +| LEAFLIST_INT | 9 | | +| LEAFLIST_UINT | 10 | | +| LEAFLIST_BOOL | 11 | | +| LEAFLIST_DECIMAL | 12 | | +| LEAFLIST_FLOAT | 13 | | +| LEAFLIST_BYTES | 14 | | +| DOUBLE | 15 | | +| LEAFLIST_DOUBLE | 16 | | + + + + + + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | 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 | int32 | int | integer | Bignum or Fixnum (as required) | +| 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 | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/onos-api/docs/onos/config/v3/admin.md b/onos-api/docs/onos/config/v3/admin.md new file mode 100644 index 0000000..18bf337 --- /dev/null +++ b/onos-api/docs/onos/config/v3/admin.md @@ -0,0 +1,683 @@ +# Protocol Documentation + + +## Table of Contents + +- [onos/config/v3/admin.proto](#onos_config_v3_admin-proto) + - [GetConfigurationRequest](#onos-config-v3-GetConfigurationRequest) + - [GetConfigurationResponse](#onos-config-v3-GetConfigurationResponse) + - [GetTransactionRequest](#onos-config-v3-GetTransactionRequest) + - [GetTransactionResponse](#onos-config-v3-GetTransactionResponse) + - [LeafSelectionQueryRequest](#onos-config-v3-LeafSelectionQueryRequest) + - [LeafSelectionQueryResponse](#onos-config-v3-LeafSelectionQueryResponse) + - [ListConfigurationsRequest](#onos-config-v3-ListConfigurationsRequest) + - [ListConfigurationsResponse](#onos-config-v3-ListConfigurationsResponse) + - [ListModelsRequest](#onos-config-v3-ListModelsRequest) + - [ListTransactionsRequest](#onos-config-v3-ListTransactionsRequest) + - [ListTransactionsResponse](#onos-config-v3-ListTransactionsResponse) + - [ModelInfo](#onos-config-v3-ModelInfo) + - [ModelInfoRequest](#onos-config-v3-ModelInfoRequest) + - [ModelInfoResponse](#onos-config-v3-ModelInfoResponse) + - [ModelPlugin](#onos-config-v3-ModelPlugin) + - [Namespace](#onos-config-v3-Namespace) + - [PathValuesRequest](#onos-config-v3-PathValuesRequest) + - [PathValuesResponse](#onos-config-v3-PathValuesResponse) + - [ReadOnlyPath](#onos-config-v3-ReadOnlyPath) + - [ReadOnlySubPath](#onos-config-v3-ReadOnlySubPath) + - [ReadWritePath](#onos-config-v3-ReadWritePath) + - [RollbackRequest](#onos-config-v3-RollbackRequest) + - [RollbackResponse](#onos-config-v3-RollbackResponse) + - [ValidateConfigChunkRequest](#onos-config-v3-ValidateConfigChunkRequest) + - [ValidateConfigRequest](#onos-config-v3-ValidateConfigRequest) + - [ValidateConfigRequestChunk](#onos-config-v3-ValidateConfigRequestChunk) + - [ValidateConfigResponse](#onos-config-v3-ValidateConfigResponse) + - [ValueSelectionRequest](#onos-config-v3-ValueSelectionRequest) + - [ValueSelectionRequestChunk](#onos-config-v3-ValueSelectionRequestChunk) + - [ValueSelectionResponse](#onos-config-v3-ValueSelectionResponse) + - [WatchConfigurationsRequest](#onos-config-v3-WatchConfigurationsRequest) + - [WatchConfigurationsResponse](#onos-config-v3-WatchConfigurationsResponse) + - [WatchTransactionsRequest](#onos-config-v3-WatchTransactionsRequest) + - [WatchTransactionsResponse](#onos-config-v3-WatchTransactionsResponse) + + - [ConfigAdminService](#onos-config-v3-ConfigAdminService) + - [ConfigurationService](#onos-config-v3-ConfigurationService) + - [ModelPluginService](#onos-config-v3-ModelPluginService) + - [TransactionService](#onos-config-v3-TransactionService) + +- [Scalar Value Types](#scalar-value-types) + + + + + + +## onos/config/v3/admin.proto + + + + + +### GetConfigurationRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| configuration_id | [ConfigurationID](#onos-config-v3-ConfigurationID) | | | + + + + + + + + +### GetConfigurationResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| configuration | [Configuration](#onos-config-v3-Configuration) | | | + + + + + + + + +### GetTransactionRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [TransactionID](#onos-config-v3-TransactionID) | | | + + + + + + + + +### GetTransactionResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| transaction | [Transaction](#onos-config-v3-Transaction) | | | + + + + + + + + +### LeafSelectionQueryRequest +LeafSelectionQueryRequest carries request for the selection of leaf values + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| target | [string](#string) | | target is the name of the target (device) to perform the query on | +| type | [string](#string) | | type of model plugin to perform the query on | +| version | [string](#string) | | version of model plugin to perform the query on | +| selectionPath | [string](#string) | | selectionPath is a configuration path to a leaf in the format: /a/b[key1=index][key2=index2]/c/d where d is a leaf node | +| changeContext | [gnmi.SetRequest](#gnmi-SetRequest) | | changeContext is the set of changes (e.g. from the GUI form) that have to be superimposed on the current configuration before the leaf selection can be made All the changes in this request should match the target given above optional | + + + + + + + + +### LeafSelectionQueryResponse +LeafSelectionQueryResponse carries response for the model information query + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| selection | [string](#string) | repeated | selection is an array of string values | + + + + + + + + +### ListConfigurationsRequest + + + + + + + + + +### ListConfigurationsResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| configuration | [Configuration](#onos-config-v3-Configuration) | | | + + + + + + + + +### ListModelsRequest +ListModelsRequest carries data for querying registered model plugins. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| verbose | [bool](#bool) | | verbose option causes all of the ReadWrite and ReadOnly paths to be included. | +| model_name | [string](#string) | | An optional filter on the name of the model plugins to list. | +| model_version | [string](#string) | | An optional filter on the version of the model plugins to list | + + + + + + + + +### ListTransactionsRequest + + + + + + + + + +### ListTransactionsResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| transaction | [Transaction](#onos-config-v3-Transaction) | | | + + + + + + + + +### ModelInfo +ModelInfo is general information about a model plugin. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | name is the name given to the model plugin - no spaces and title case. | +| version | [string](#string) | | version is the semantic version of the Plugin e.g. 1.0.0. | +| model_data | [gnmi.ModelData](#gnmi-ModelData) | repeated | model_data is a set of metadata about the YANG files that went in to generating the model plugin. It includes name, version and organization for each YANG file, similar to how they are represented in gNMI Capabilities. | +| module | [string](#string) | | **Deprecated.** module is no longer used | +| getStateMode | [uint32](#uint32) | | getStateMode is flag that defines how the "get state" operation works. 0) means that no retrieval of state is attempted 1) means that the synchronizer will make 2 requests to the device - one for Get with State and another for Get with Operational. 2) means that the synchronizer will do a Get request comprising of each one of the ReadOnlyPaths and their sub paths. If there is a `list` in any one of these paths it will be sent down as is, expecting the devices implementation of gNMI will be able to expand wildcards. 3) means that the synchronizer will do a Get request comprising of each one of the ReadOnlyPaths and their sub paths. If there is a `list` in any one of these paths, a separate call will be made first to find all the instances in the list and a Get including these expanded wildcards will be sent down to the device. | +| read_only_path | [ReadOnlyPath](#onos-config-v3-ReadOnlyPath) | repeated | read_only_path is all of the read only paths for the model plugin. | +| read_write_path | [ReadWritePath](#onos-config-v3-ReadWritePath) | repeated | read_write_path is all of the read write paths for the model plugin. | +| supported_encodings | [gnmi.Encoding](#gnmi-Encoding) | repeated | | +| namespace_mappings | [Namespace](#onos-config-v3-Namespace) | repeated | namespace_mappings is a set of all prefix to module name mapping in the model | +| southboundUsePrefix | [bool](#bool) | | southboundUsePrefix indicates that the southbound should add prefixes in gNMI paths | + + + + + + + + +### ModelInfoRequest +ModelInfoRequest carries request for the model information + + + + + + + + +### ModelInfoResponse +ModelInfoResponse carries response for the model information query + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| modelInfo | [ModelInfo](#onos-config-v3-ModelInfo) | | | + + + + + + + + +### ModelPlugin + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | | +| endpoint | [string](#string) | | | +| info | [ModelInfo](#onos-config-v3-ModelInfo) | | | +| status | [string](#string) | | | +| error | [string](#string) | | | + + + + + + + + +### Namespace +Namespace is a mapping between a module name and its shorthand prefix + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| module | [string](#string) | | | +| prefix | [string](#string) | | | + + + + + + + + +### PathValuesRequest +PathValuesRequest carries configuration change as a JSON blob + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| pathPrefix | [string](#string) | | | +| json | [bytes](#bytes) | | | + + + + + + + + +### PathValuesResponse +PathValuesResponse carries a list of typed path values + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| pathValues | [PathValue](#onos-config-v3-PathValue) | repeated | | + + + + + + + + +### ReadOnlyPath +ReadOnlyPath extracted from the model plugin as the definition of a tree of read only items. +In YANG models items are defined as ReadOnly with the `config false` keyword. +This can be applied to single items (leafs) or collections (containers or lists). +When this `config false` is applied to an object every item beneath it will +also become readonly - here these are shown as subpaths. +The complete read only path then will be a concatenation of both e.g. +/cont1a/cont1b-state/list2b/index and the type is defined in the SubPath as UInt8. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| path | [string](#string) | | path of the topmost `config false` object e.g. /cont1a/cont1b-state | +| sub_path | [ReadOnlySubPath](#onos-config-v3-ReadOnlySubPath) | repeated | ReadOnlySubPath is a set of children of the path including an entry for the type of the topmost object with subpath `/` An example is /list2b/index | + + + + + + + + +### ReadOnlySubPath +ReadOnlySubPath is an extension to the ReadOnlyPath to define the datatype of +the subpath + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| sub_path | [string](#string) | | sub_path is the relative path of a child object e.g. /list2b/index | +| value_type | [ValueType](#onos-config-v3-ValueType) | | value_type is the datatype of the read only path | +| type_opts | [uint64](#uint64) | repeated | | +| description | [string](#string) | | | +| units | [string](#string) | | | +| IsAKey | [bool](#bool) | | | +| AttrName | [string](#string) | | | + + + + + + + + +### ReadWritePath +ReadWritePath is extracted from the model plugin as the definition of a writeable attributes. +In YANG models items are writable by default unless they are specified as `config false` or +have an item with `config false` as a parent. +Each configurable item has metadata with meanings taken from the YANG specification RFC 6020. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| path | [string](#string) | | path is the full path to the attribute (leaf or leaf-list) | +| value_type | [ValueType](#onos-config-v3-ValueType) | | value_type is the data type of the attribute | +| units | [string](#string) | | units is the unit of measurement e.g. dB, mV | +| description | [string](#string) | | description is an explaination of the meaning of the attribute | +| mandatory | [bool](#bool) | | mandatory shows whether the attribute is optional (false) or required (true) | +| default | [string](#string) | | **Deprecated.** default is a default value used with optional attributes. Replaced by 'defaults' below | +| range | [string](#string) | repeated | range is definition of the range of values a value is allowed | +| length | [string](#string) | repeated | length is a defintion of the length restrictions for the attribute | +| type_opts | [uint64](#uint64) | repeated | | +| IsAKey | [bool](#bool) | | | +| AttrName | [string](#string) | | | +| defaults | [string](#string) | repeated | defaults is a default value(s) used with optional attributes. For leaf-list can have repeated values replaces the 'default' attribute above | + + + + + + + + +### RollbackRequest +RollbackRequest carries the index of the configuration change transaction to rollback. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| transaction_id | [TransactionID](#onos-config-v3-TransactionID) | | | + + + + + + + + +### RollbackResponse +RollbackResponse carries the response of the rollback operation + + + + + + + + +### ValidateConfigChunkRequest +ValidateConfigRequest carries configuration data to be validated as a JSON blob + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| json | [bytes](#bytes) | | | + + + + + + + + +### ValidateConfigRequest +ValidateConfigRequest carries configuration data to be validated as a JSON blob + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| json | [bytes](#bytes) | | | + + + + + + + + +### ValidateConfigRequestChunk +ValidateConfigRequestChunk carries configuration data to be validated as a JSON blob +Recommended maximum size is 100kB + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| json | [bytes](#bytes) | | | + + + + + + + + +### ValidateConfigResponse +ValidateConfigResponse carries the result of the validation + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| valid | [bool](#bool) | | | +| message | [string](#string) | | | + + + + + + + + +### ValueSelectionRequest +ValueSelectionRequest carries the necessary parts to form a selection context + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| selectionPath | [string](#string) | | selectionPath is a configuration path to a leaf in the format: /a/b[key1=index][key2=index2]/c/d where d is a leaf node | +| configJson | [bytes](#bytes) | | configJson is a JSON tree view of the complete Configuration for a Target | + + + + + + + + +### ValueSelectionRequestChunk +ValueSelectionRequestChunk carries the necessary parts to form a selection context +Recommended maximum size is 100kB + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| selectionPath | [string](#string) | | selectionPath is a configuration path to a leaf in the format: /a/b[key1=index][key2=index2]/c/d where d is a leaf node | +| configJson | [bytes](#bytes) | | configJson is a JSON tree view of the complete Configuration for a Target | + + + + + + + + +### ValueSelectionResponse +ValueSelectionResponse returns the result of applying the selection rules to the selection context + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| selection | [string](#string) | repeated | selection is an array of string values | + + + + + + + + +### WatchConfigurationsRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| configuration_id | [ConfigurationID](#onos-config-v3-ConfigurationID) | | | +| noreplay | [bool](#bool) | | | + + + + + + + + +### WatchConfigurationsResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| event | [ConfigurationEvent](#onos-config-v3-ConfigurationEvent) | | | + + + + + + + + +### WatchTransactionsRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| transaction_id | [TransactionID](#onos-config-v3-TransactionID) | | | +| noreplay | [bool](#bool) | | | + + + + + + + + +### WatchTransactionsResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| event | [TransactionEvent](#onos-config-v3-TransactionEvent) | | | + + + + + + + + + + + + + + +### ConfigAdminService +ConfigAdminService provides means for enhanced interactions with the configuration subsystem. + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| ListRegisteredModels | [ListModelsRequest](#onos-config-v3-ListModelsRequest) | [ModelPlugin](#onos-config-v3-ModelPlugin) stream | ListRegisteredModels returns a stream of registered models. | +| RollbackTransaction | [RollbackRequest](#onos-config-v3-RollbackRequest) | [RollbackResponse](#onos-config-v3-RollbackResponse) | RollbackTransaction rolls back the specified configuration change transaction. | +| LeafSelectionQuery | [LeafSelectionQueryRequest](#onos-config-v3-LeafSelectionQueryRequest) | [LeafSelectionQueryResponse](#onos-config-v3-LeafSelectionQueryResponse) | LeafSelectionQuery selects values allowable for leaf. It supports the ROC GUI by supplying a list of valid leaf values based off an XPath query defined in a 'leaf-selection' YANG extension Calls on GetValueSelection RPC on Model Plugin | + + + + +### ConfigurationService +ConfigurationService provides means to inspect the contents of the internal configurations store. + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| GetConfiguration | [GetConfigurationRequest](#onos-config-v3-GetConfigurationRequest) | [GetConfigurationResponse](#onos-config-v3-GetConfigurationResponse) | Get configuration by its target ID | +| ListConfigurations | [ListConfigurationsRequest](#onos-config-v3-ListConfigurationsRequest) | [ListConfigurationsResponse](#onos-config-v3-ListConfigurationsResponse) stream | List returns all target configurations | +| WatchConfigurations | [WatchConfigurationsRequest](#onos-config-v3-WatchConfigurationsRequest) | [WatchConfigurationsResponse](#onos-config-v3-WatchConfigurationsResponse) stream | Watch returns a stream of configuration change notifications | + + + + +### ModelPluginService +ModelPluginService is to be implemented by model plugin sidecar + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| GetModelInfo | [ModelInfoRequest](#onos-config-v3-ModelInfoRequest) | [ModelInfoResponse](#onos-config-v3-ModelInfoResponse) | GetModelInfo provides information about the model | +| ValidateConfig | [ValidateConfigRequest](#onos-config-v3-ValidateConfigRequest) | [ValidateConfigResponse](#onos-config-v3-ValidateConfigResponse) | ValidateConfig validates the provided configuration data against the model | +| ValidateConfigChunked | [ValidateConfigRequestChunk](#onos-config-v3-ValidateConfigRequestChunk) stream | [ValidateConfigResponse](#onos-config-v3-ValidateConfigResponse) | ValidateConfigChunked validates the provided configuration data against the model | +| GetPathValues | [PathValuesRequest](#onos-config-v3-PathValuesRequest) | [PathValuesResponse](#onos-config-v3-PathValuesResponse) | GetPathValues produces list of typed path value entries from the specified configuration change JSON tree | +| GetValueSelection | [ValueSelectionRequest](#onos-config-v3-ValueSelectionRequest) | [ValueSelectionResponse](#onos-config-v3-ValueSelectionResponse) | GetValueSelection gets a list of valid options for a leaf by applying selection rules in YANG. Replaced by GetValueSelectionChunked | +| GetValueSelectionChunked | [ValueSelectionRequestChunk](#onos-config-v3-ValueSelectionRequestChunk) stream | [ValueSelectionResponse](#onos-config-v3-ValueSelectionResponse) | GetValueSelectionChunked gets a list of valid options for a leaf by applying selection rules in YANG. The selection rules should be defined as an XPath expression, as an argument to a `leaf-selection` extension in the YANG model (Used to support the ROC GUI) | + + + + +### TransactionService +TransactionService provides means to inspect the contents of the internal transactions store. + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| GetTransaction | [GetTransactionRequest](#onos-config-v3-GetTransactionRequest) | [GetTransactionResponse](#onos-config-v3-GetTransactionResponse) | Get transaction by its ID or index | +| ListTransactions | [ListTransactionsRequest](#onos-config-v3-ListTransactionsRequest) | [ListTransactionsResponse](#onos-config-v3-ListTransactionsResponse) stream | List returns all configuration transactions | +| WatchTransactions | [WatchTransactionsRequest](#onos-config-v3-WatchTransactionsRequest) | [WatchTransactionsResponse](#onos-config-v3-WatchTransactionsResponse) stream | Watch returns a stream of configuration transaction change notifications | + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | 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 | int32 | int | integer | Bignum or Fixnum (as required) | +| 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 | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/onos-api/docs/onos/config/v3/configuration.md b/onos-api/docs/onos/config/v3/configuration.md new file mode 100644 index 0000000..b147aa8 --- /dev/null +++ b/onos-api/docs/onos/config/v3/configuration.md @@ -0,0 +1,242 @@ +# Protocol Documentation + + +## Table of Contents + +- [onos/config/v3/configuration.proto](#onos_config_v3_configuration-proto) + - [AppliedConfiguration](#onos-config-v3-AppliedConfiguration) + - [AppliedConfiguration.ValuesEntry](#onos-config-v3-AppliedConfiguration-ValuesEntry) + - [CommittedConfiguration](#onos-config-v3-CommittedConfiguration) + - [CommittedConfiguration.ValuesEntry](#onos-config-v3-CommittedConfiguration-ValuesEntry) + - [Configuration](#onos-config-v3-Configuration) + - [ConfigurationEvent](#onos-config-v3-ConfigurationEvent) + - [ConfigurationID](#onos-config-v3-ConfigurationID) + - [ConfigurationStatus](#onos-config-v3-ConfigurationStatus) + - [MastershipStatus](#onos-config-v3-MastershipStatus) + + - [ConfigurationEvent.EventType](#onos-config-v3-ConfigurationEvent-EventType) + - [ConfigurationStatus.State](#onos-config-v3-ConfigurationStatus-State) + +- [Scalar Value Types](#scalar-value-types) + + + + + + +## onos/config/v3/configuration.proto + + + + + +### AppliedConfiguration + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| index | [uint64](#uint64) | | | +| ordinal | [uint64](#uint64) | | | +| revision | [uint64](#uint64) | | | +| target | [uint64](#uint64) | | | +| term | [uint64](#uint64) | | | +| values | [AppliedConfiguration.ValuesEntry](#onos-config-v3-AppliedConfiguration-ValuesEntry) | repeated | | + + + + + + + + +### AppliedConfiguration.ValuesEntry + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [PathValue](#onos-config-v3-PathValue) | | | + + + + + + + + +### CommittedConfiguration + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| index | [uint64](#uint64) | | | +| ordinal | [uint64](#uint64) | | | +| revision | [uint64](#uint64) | | | +| target | [uint64](#uint64) | | | +| change | [uint64](#uint64) | | | +| values | [CommittedConfiguration.ValuesEntry](#onos-config-v3-CommittedConfiguration-ValuesEntry) | repeated | | + + + + + + + + +### CommittedConfiguration.ValuesEntry + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [PathValue](#onos-config-v3-PathValue) | | | + + + + + + + + +### Configuration +Configuration represents complete desired target configuration + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| meta | [ObjectMeta](#onos-config-v3-ObjectMeta) | | | +| id | [ConfigurationID](#onos-config-v3-ConfigurationID) | | 'id' is the unique identifier of the configuration | +| committed | [CommittedConfiguration](#onos-config-v3-CommittedConfiguration) | | | +| applied | [AppliedConfiguration](#onos-config-v3-AppliedConfiguration) | | | +| status | [ConfigurationStatus](#onos-config-v3-ConfigurationStatus) | | 'ConfigurationStatus' is the current lifecycle status of the configuration | + + + + + + + + +### ConfigurationEvent +ConfigurationEvent configuration store event + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| type | [ConfigurationEvent.EventType](#onos-config-v3-ConfigurationEvent-EventType) | | EventType configuration event type | +| configuration | [Configuration](#onos-config-v3-Configuration) | | | + + + + + + + + +### ConfigurationID + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| target | [Target](#onos-config-v3-Target) | | | + + + + + + + + +### ConfigurationStatus +ConfigurationStatus is the status of a Configuration + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| state | [ConfigurationStatus.State](#onos-config-v3-ConfigurationStatus-State) | | 'state' is the configuration state | +| mastership | [MastershipStatus](#onos-config-v3-MastershipStatus) | | | + + + + + + + + +### MastershipStatus + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| master | [string](#string) | | | +| term | [uint64](#uint64) | | | + + + + + + + + + + +### ConfigurationEvent.EventType +EventType configuration event types for configuration store + +| Name | Number | Description | +| ---- | ------ | ----------- | +| UNKNOWN | 0 | UNKNOWN indicates unknown configuration store event | +| CREATED | 1 | CREATED indicates the configuration entry in the store is created | +| UPDATED | 2 | UPDATED indicates the configuration entry in the store is updated | +| DELETED | 3 | DELETED indicates the configuration entry in the store is deleted | +| REPLAYED | 4 | REPLAYED | + + + + + +### ConfigurationStatus.State +State is the configuration state + +| Name | Number | Description | +| ---- | ------ | ----------- | +| UNKNOWN | 0 | | +| SYNCHRONIZING | 1 | | +| SYNCHRONIZED | 2 | | +| PERSISTED | 3 | | + + + + + + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | 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 | int32 | int | integer | Bignum or Fixnum (as required) | +| 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 | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/onos-api/docs/onos/config/v3/transaction.md b/onos-api/docs/onos/config/v3/transaction.md new file mode 100644 index 0000000..d282093 --- /dev/null +++ b/onos-api/docs/onos/config/v3/transaction.md @@ -0,0 +1,285 @@ +# Protocol Documentation + + +## Table of Contents + +- [onos/config/v3/transaction.proto](#onos_config_v3_transaction-proto) + - [Transaction](#onos-config-v3-Transaction) + - [Transaction.ValuesEntry](#onos-config-v3-Transaction-ValuesEntry) + - [TransactionChangeStatus](#onos-config-v3-TransactionChangeStatus) + - [TransactionEvent](#onos-config-v3-TransactionEvent) + - [TransactionID](#onos-config-v3-TransactionID) + - [TransactionPhaseStatus](#onos-config-v3-TransactionPhaseStatus) + - [TransactionRollbackStatus](#onos-config-v3-TransactionRollbackStatus) + - [TransactionRollbackStatus.ValuesEntry](#onos-config-v3-TransactionRollbackStatus-ValuesEntry) + - [TransactionStatus](#onos-config-v3-TransactionStatus) + - [TransactionStrategy](#onos-config-v3-TransactionStrategy) + + - [TransactionEvent.EventType](#onos-config-v3-TransactionEvent-EventType) + - [TransactionPhaseStatus.State](#onos-config-v3-TransactionPhaseStatus-State) + - [TransactionStatus.Phase](#onos-config-v3-TransactionStatus-Phase) + - [TransactionStrategy.Synchronicity](#onos-config-v3-TransactionStrategy-Synchronicity) + +- [Scalar Value Types](#scalar-value-types) + + + + + + +## onos/config/v3/transaction.proto + + + + + +### Transaction + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| meta | [ObjectMeta](#onos-config-v3-ObjectMeta) | | | +| id | [TransactionID](#onos-config-v3-TransactionID) | | 'id' is the unique identifier of the transaction | +| values | [Transaction.ValuesEntry](#onos-config-v3-Transaction-ValuesEntry) | repeated | 'values' is a set of changes to apply to targets | +| status | [TransactionStatus](#onos-config-v3-TransactionStatus) | | 'status' is the transaction status | + + + + + + + + +### Transaction.ValuesEntry + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [PathValue](#onos-config-v3-PathValue) | | | + + + + + + + + +### TransactionChangeStatus + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| ordinal | [uint64](#uint64) | | | +| commit | [TransactionPhaseStatus](#onos-config-v3-TransactionPhaseStatus) | | | +| apply | [TransactionPhaseStatus](#onos-config-v3-TransactionPhaseStatus) | | | + + + + + + + + +### TransactionEvent +TransactionEvent transaction store event + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| type | [TransactionEvent.EventType](#onos-config-v3-TransactionEvent-EventType) | | | +| transaction | [Transaction](#onos-config-v3-Transaction) | | | + + + + + + + + +### TransactionID + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| target | [Target](#onos-config-v3-Target) | | | +| index | [uint64](#uint64) | | | + + + + + + + + +### TransactionPhaseStatus + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| start | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | | +| end | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | | +| state | [TransactionPhaseStatus.State](#onos-config-v3-TransactionPhaseStatus-State) | | | +| failure | [Failure](#onos-config-v3-Failure) | | | + + + + + + + + +### TransactionRollbackStatus + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| ordinal | [uint64](#uint64) | | | +| commit | [TransactionPhaseStatus](#onos-config-v3-TransactionPhaseStatus) | | | +| apply | [TransactionPhaseStatus](#onos-config-v3-TransactionPhaseStatus) | | | +| index | [uint64](#uint64) | | | +| values | [TransactionRollbackStatus.ValuesEntry](#onos-config-v3-TransactionRollbackStatus-ValuesEntry) | repeated | | + + + + + + + + +### TransactionRollbackStatus.ValuesEntry + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [PathValue](#onos-config-v3-PathValue) | | | + + + + + + + + +### TransactionStatus + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| phase | [TransactionStatus.Phase](#onos-config-v3-TransactionStatus-Phase) | | | +| change | [TransactionChangeStatus](#onos-config-v3-TransactionChangeStatus) | | | +| rollback | [TransactionRollbackStatus](#onos-config-v3-TransactionRollbackStatus) | | | + + + + + + + + +### TransactionStrategy + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| synchronicity | [TransactionStrategy.Synchronicity](#onos-config-v3-TransactionStrategy-Synchronicity) | | 'synchronicity' indicates the transaction synchronicity level | + + + + + + + + + + +### TransactionEvent.EventType +EventType transaction event types for transaction store + +| Name | Number | Description | +| ---- | ------ | ----------- | +| UNKNOWN | 0 | | +| CREATED | 1 | | +| UPDATED | 2 | | +| DELETED | 3 | | +| REPLAYED | 4 | | + + + + + +### TransactionPhaseStatus.State + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| PENDING | 0 | | +| IN_PROGRESS | 1 | | +| COMPLETE | 2 | | +| ABORTED | 3 | | +| CANCELED | 4 | | +| FAILED | 5 | | + + + + + +### TransactionStatus.Phase + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| CHANGE | 0 | | +| ROLLBACK | 1 | | + + + + + +### TransactionStrategy.Synchronicity + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| ASYNCHRONOUS | 0 | | +| SYNCHRONOUS | 1 | | + + + + + + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | 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 | int32 | int | integer | Bignum or Fixnum (as required) | +| 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 | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/onos-api/docs/onos/config/v3/value.md b/onos-api/docs/onos/config/v3/value.md new file mode 100644 index 0000000..b7e70cd --- /dev/null +++ b/onos-api/docs/onos/config/v3/value.md @@ -0,0 +1,146 @@ +# Protocol Documentation + + +## Table of Contents + +- [onos/config/v3/value.proto](#onos_config_v3_value-proto) + - [PathValue](#onos-config-v3-PathValue) + - [PathValues](#onos-config-v3-PathValues) + - [PathValues.ValuesEntry](#onos-config-v3-PathValues-ValuesEntry) + - [TypedValue](#onos-config-v3-TypedValue) + + - [ValueType](#onos-config-v3-ValueType) + +- [Scalar Value Types](#scalar-value-types) + + + + + + +## onos/config/v3/value.proto + + + + + +### PathValue +PathValue is the state of a path/value in the configuration tree + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| path | [string](#string) | | 'path' is the path to change | +| value | [TypedValue](#onos-config-v3-TypedValue) | | 'value' is the change value | +| deleted | [bool](#bool) | | 'deleted' indicates whether this is a delete | +| index | [uint64](#uint64) | | index transaction index | + + + + + + + + +### PathValues +PathValues is a set of path/value pairs + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| values | [PathValues.ValuesEntry](#onos-config-v3-PathValues-ValuesEntry) | repeated | 'values' is a set of change values to apply | + + + + + + + + +### PathValues.ValuesEntry + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [PathValue](#onos-config-v3-PathValue) | | | + + + + + + + + +### TypedValue +TypedValue is a value represented as a byte array + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| bytes | [bytes](#bytes) | | 'bytes' is the bytes array | +| type | [ValueType](#onos-config-v3-ValueType) | | 'type' is the value type | +| type_opts | [int32](#int32) | repeated | 'type_opts' is a set of type options | + + + + + + + + + + +### ValueType +ValueType is the type for a value + +| Name | Number | Description | +| ---- | ------ | ----------- | +| EMPTY | 0 | | +| STRING | 1 | | +| INT | 2 | | +| UINT | 3 | | +| BOOL | 4 | | +| DECIMAL | 5 | | +| FLOAT | 6 | | +| BYTES | 7 | | +| LEAFLIST_STRING | 8 | | +| LEAFLIST_INT | 9 | | +| LEAFLIST_UINT | 10 | | +| LEAFLIST_BOOL | 11 | | +| LEAFLIST_DECIMAL | 12 | | +| LEAFLIST_FLOAT | 13 | | +| LEAFLIST_BYTES | 14 | | +| DOUBLE | 15 | | +| LEAFLIST_DOUBLE | 16 | | + + + + + + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | 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 | int32 | int | integer | Bignum or Fixnum (as required) | +| 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 | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/onos-api/docs/onos/discovery/discovery.md b/onos-api/docs/onos/discovery/discovery.md new file mode 100644 index 0000000..48bde1d --- /dev/null +++ b/onos-api/docs/onos/discovery/discovery.md @@ -0,0 +1,221 @@ +# Protocol Documentation + + +## Table of Contents + +- [onos/discovery/discovery.proto](#onos_discovery_discovery-proto) + - [AddPodRequest](#onos-discovery-AddPodRequest) + - [AddPodResponse](#onos-discovery-AddPodResponse) + - [AddRackRequest](#onos-discovery-AddRackRequest) + - [AddRackResponse](#onos-discovery-AddRackResponse) + - [AddServerIPURequest](#onos-discovery-AddServerIPURequest) + - [AddServerIPUResponse](#onos-discovery-AddServerIPUResponse) + - [AddSwitchRequest](#onos-discovery-AddSwitchRequest) + - [AddSwitchResponse](#onos-discovery-AddSwitchResponse) + - [InjectedLink](#onos-discovery-InjectedLink) + - [ManagementInfo](#onos-discovery-ManagementInfo) + + - [DiscoveryService](#onos-discovery-DiscoveryService) + +- [Scalar Value Types](#scalar-value-types) + + + + + + +## onos/discovery/discovery.proto + + + + + +### AddPodRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | | + + + + + + + + +### AddPodResponse + + + + + + + + + +### AddRackRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | | +| pod_id | [string](#string) | | | + + + + + + + + +### AddRackResponse + + + + + + + + + +### AddServerIPURequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | | +| pod_id | [string](#string) | | | +| rack_id | [string](#string) | | | +| management_info | [ManagementInfo](#onos-discovery-ManagementInfo) | | | +| links | [InjectedLink](#onos-discovery-InjectedLink) | repeated | Provisional feature used to inject links until dynamic discovery is available | + + + + + + + + +### AddServerIPUResponse + + + + + + + + + +### AddSwitchRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | | +| pod_id | [string](#string) | | | +| rack_id | [string](#string) | | | +| management_info | [ManagementInfo](#onos-discovery-ManagementInfo) | | | + + + + + + + + +### AddSwitchResponse + + + + + + + + + +### InjectedLink + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| port | [uint64](#uint64) | | | +| remote_port | [string](#string) | | | + + + + + + + + +### ManagementInfo + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| p4rt_endpoint | [string](#string) | | | +| gnmi_endpoint | [string](#string) | | | +| pipeline_config_id | [string](#string) | | | +| chassis_config_id | [string](#string) | | | +| link_agent_endpoint | [string](#string) | | | +| host_agent_endpoint | [string](#string) | | | +| nat_agent_endpoint | [string](#string) | | | +| device_id | [uint64](#uint64) | | | +| realm | [string](#string) | | | +| role | [string](#string) | | | + + + + + + + + + + + + + + +### DiscoveryService +DiscoveryService allows injection of topology objects to act as seeds for the topology +discovery. + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| AddPod | [AddPodRequest](#onos-discovery-AddPodRequest) | [AddPodResponse](#onos-discovery-AddPodResponse) | AddPod adds a new POD entity with the requisite aspects | +| AddRack | [AddRackRequest](#onos-discovery-AddRackRequest) | [AddRackResponse](#onos-discovery-AddRackResponse) | AddRack adds a new rack entity with the requisite aspects as part of a POD | +| AddSwitch | [AddSwitchRequest](#onos-discovery-AddSwitchRequest) | [AddSwitchResponse](#onos-discovery-AddSwitchResponse) | AddSwitch adds a new switch entity with the requisite aspects into a rack | +| AddServerIPU | [AddServerIPURequest](#onos-discovery-AddServerIPURequest) | [AddServerIPUResponse](#onos-discovery-AddServerIPUResponse) | AddServerIPU adds a new server entity and an associated IPU entity, both with the requisite aspects into a rack | + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | 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 | int32 | int | integer | Bignum or Fixnum (as required) | +| 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 | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/onos-api/docs/onos/e2t/admin.md b/onos-api/docs/onos/e2t/admin.md new file mode 100644 index 0000000..241e80e --- /dev/null +++ b/onos-api/docs/onos/e2t/admin.md @@ -0,0 +1,233 @@ +# Protocol Documentation + + +## Table of Contents + +- [onos/e2t/admin/admin.proto](#onos_e2t_admin_admin-proto) + - [DropE2NodeConnectionsRequest](#onos-e2t-admin-DropE2NodeConnectionsRequest) + - [DropE2NodeConnectionsResponse](#onos-e2t-admin-DropE2NodeConnectionsResponse) + - [ListE2NodeConnectionsRequest](#onos-e2t-admin-ListE2NodeConnectionsRequest) + - [ListE2NodeConnectionsResponse](#onos-e2t-admin-ListE2NodeConnectionsResponse) + - [ListRegisteredServiceModelsRequest](#onos-e2t-admin-ListRegisteredServiceModelsRequest) + - [ListRegisteredServiceModelsResponse](#onos-e2t-admin-ListRegisteredServiceModelsResponse) + - [RANFunction](#onos-e2t-admin-RANFunction) + - [UploadRegisterServiceModelRequest](#onos-e2t-admin-UploadRegisterServiceModelRequest) + - [UploadRegisterServiceModelResponse](#onos-e2t-admin-UploadRegisterServiceModelResponse) + + - [E2NodeConnectionType](#onos-e2t-admin-E2NodeConnectionType) + + - [E2TAdminService](#onos-e2t-admin-E2TAdminService) + +- [Scalar Value Types](#scalar-value-types) + + + + + + +## onos/e2t/admin/admin.proto + + + + + +### DropE2NodeConnectionsRequest +DropE2NodeConnectionsRequest carries drop connection request + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| connections | [ListE2NodeConnectionsResponse](#onos-e2t-admin-ListE2NodeConnectionsResponse) | repeated | | + + + + + + + + +### DropE2NodeConnectionsResponse +DropE2NodeConnectionsResponse carries drop connection response + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| success | [bool](#bool) | repeated | | + + + + + + + + +### ListE2NodeConnectionsRequest +ListE2NodeConnectionsRequest carries request for a list of E2 node SCTP connections. + + + + + + + + +### ListE2NodeConnectionsResponse +ListE2NodeConnectionsResponse carries information about the SCTP connection to the remote E2 node. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | | +| remote_ip | [string](#string) | repeated | | +| remote_port | [uint32](#uint32) | | | +| node_id | [string](#string) | | | +| plmn_id | [string](#string) | | | +| connection_type | [E2NodeConnectionType](#onos-e2t-admin-E2NodeConnectionType) | | | +| ran_functions | [RANFunction](#onos-e2t-admin-RANFunction) | repeated | | +| age_ms | [int32](#int32) | | | + + + + + + + + +### ListRegisteredServiceModelsRequest +ListRegisteredServiceModelsRequest carries data for querying registered service model plugins. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| model_name | [string](#string) | | An optional filter on the name of the model plugins to list. | +| model_version | [string](#string) | | An optional filter on the version of the model plugins to list | + + + + + + + + +### ListRegisteredServiceModelsResponse +ListRegisteredServiceModelsResponse is general information about a service model plugin. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | name is the name given to the service model plugin - no spaces and title case. | +| version | [string](#string) | | version is the semantic version of the Plugin e.g. 1.0.0. | + + + + + + + + +### RANFunction + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| oid | [string](#string) | | | +| ran_function_id | [string](#string) | | | +| description | [bytes](#bytes) | | | + + + + + + + + +### UploadRegisterServiceModelRequest +UploadRegisterServiceModelRequest is for streaming a model plugin file to the server. +There is a built in limit in gRPC of 4MB - plugin is usually around 20MB +so break in to chunks of approx 1-2MB. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| so_file | [string](#string) | | so_file is the name being streamed. | +| content | [bytes](#bytes) | | content is the bytes content. | + + + + + + + + +### UploadRegisterServiceModelResponse +UploadRegisterServiceModelResponse carries status of model plugin registration. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | name is name of the model plugin. | +| version | [string](#string) | | version is the semantic version of the model plugin. | + + + + + + + + + + +### E2NodeConnectionType +E2NodeConnectionType specifies the type of an E2 connection + +| Name | Number | Description | +| ---- | ------ | ----------- | +| UNKNOWN | 0 | | +| G_NB | 1 | | +| E_NB | 2 | | +| ENG_MB | 3 | | +| NGE_NB | 4 | | + + + + + + + + + +### E2TAdminService +E2TAdminService provides means for enhanced interactions with the ONOS RIC E2 Termination service. + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| UploadRegisterServiceModel | [UploadRegisterServiceModelRequest](#onos-e2t-admin-UploadRegisterServiceModelRequest) stream | [UploadRegisterServiceModelResponse](#onos-e2t-admin-UploadRegisterServiceModelResponse) | UploadRegisterServiceModel uploads and adds the model plugin to the list of supported models. The file is serialized in to Chunks of less than 4MB so as not to break the gRPC byte array limit | +| ListRegisteredServiceModels | [ListRegisteredServiceModelsRequest](#onos-e2t-admin-ListRegisteredServiceModelsRequest) | [ListRegisteredServiceModelsResponse](#onos-e2t-admin-ListRegisteredServiceModelsResponse) stream | ListRegisteredServiceModels returns a stream of registered service models. | +| ListE2NodeConnections | [ListE2NodeConnectionsRequest](#onos-e2t-admin-ListE2NodeConnectionsRequest) | [ListE2NodeConnectionsResponse](#onos-e2t-admin-ListE2NodeConnectionsResponse) stream | ListE2NodeConnections returns a stream of existing SCTP connections. | +| DropE2NodeConnections | [DropE2NodeConnectionsRequest](#onos-e2t-admin-DropE2NodeConnectionsRequest) | [DropE2NodeConnectionsResponse](#onos-e2t-admin-DropE2NodeConnectionsResponse) | DropE2NodeConnections drops the specified E2 node SCTP connections | + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | 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 | int32 | int | integer | Bignum or Fixnum (as required) | +| 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 | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/onos-api/docs/onos/e2t/e2.md b/onos-api/docs/onos/e2t/e2.md new file mode 100644 index 0000000..f1468a7 --- /dev/null +++ b/onos-api/docs/onos/e2t/e2.md @@ -0,0 +1,1147 @@ +# Protocol Documentation + + +## Table of Contents + +- [onos/e2t/e2/v1beta1/control.proto](#onos_e2t_e2_v1beta1_control-proto) + - [ControlMessage](#onos-e2t-e2-v1beta1-ControlMessage) + - [ControlOutcome](#onos-e2t-e2-v1beta1-ControlOutcome) + - [ControlRequest](#onos-e2t-e2-v1beta1-ControlRequest) + - [ControlResponse](#onos-e2t-e2-v1beta1-ControlResponse) + + - [ControlService](#onos-e2t-e2-v1beta1-ControlService) + +- [onos/e2t/e2/v1beta1/e2.proto](#onos_e2t_e2_v1beta1_e2-proto) + - [Error](#onos-e2t-e2-v1beta1-Error) + - [Error.Cause](#onos-e2t-e2-v1beta1-Error-Cause) + - [Error.Cause.Misc](#onos-e2t-e2-v1beta1-Error-Cause-Misc) + - [Error.Cause.Protocol](#onos-e2t-e2-v1beta1-Error-Cause-Protocol) + - [Error.Cause.Ric](#onos-e2t-e2-v1beta1-Error-Cause-Ric) + - [Error.Cause.RicService](#onos-e2t-e2-v1beta1-Error-Cause-RicService) + - [Error.Cause.Transport](#onos-e2t-e2-v1beta1-Error-Cause-Transport) + - [Error.Cause.Unknown](#onos-e2t-e2-v1beta1-Error-Cause-Unknown) + - [RequestHeaders](#onos-e2t-e2-v1beta1-RequestHeaders) + - [ResponseHeaders](#onos-e2t-e2-v1beta1-ResponseHeaders) + - [ServiceModel](#onos-e2t-e2-v1beta1-ServiceModel) + + - [Encoding](#onos-e2t-e2-v1beta1-Encoding) + - [Error.Cause.Misc.Type](#onos-e2t-e2-v1beta1-Error-Cause-Misc-Type) + - [Error.Cause.Protocol.Type](#onos-e2t-e2-v1beta1-Error-Cause-Protocol-Type) + - [Error.Cause.Ric.Type](#onos-e2t-e2-v1beta1-Error-Cause-Ric-Type) + - [Error.Cause.RicService.Type](#onos-e2t-e2-v1beta1-Error-Cause-RicService-Type) + - [Error.Cause.Transport.Type](#onos-e2t-e2-v1beta1-Error-Cause-Transport-Type) + +- [onos/e2t/e2/v1beta1/subscription.proto](#onos_e2t_e2_v1beta1_subscription-proto) + - [Acknowledgement](#onos-e2t-e2-v1beta1-Acknowledgement) + - [Action](#onos-e2t-e2-v1beta1-Action) + - [Channel](#onos-e2t-e2-v1beta1-Channel) + - [ChannelEvent](#onos-e2t-e2-v1beta1-ChannelEvent) + - [ChannelMeta](#onos-e2t-e2-v1beta1-ChannelMeta) + - [ChannelSpec](#onos-e2t-e2-v1beta1-ChannelSpec) + - [ChannelStatus](#onos-e2t-e2-v1beta1-ChannelStatus) + - [EventTrigger](#onos-e2t-e2-v1beta1-EventTrigger) + - [GetChannelRequest](#onos-e2t-e2-v1beta1-GetChannelRequest) + - [GetChannelResponse](#onos-e2t-e2-v1beta1-GetChannelResponse) + - [GetSubscriptionRequest](#onos-e2t-e2-v1beta1-GetSubscriptionRequest) + - [GetSubscriptionResponse](#onos-e2t-e2-v1beta1-GetSubscriptionResponse) + - [Indication](#onos-e2t-e2-v1beta1-Indication) + - [ListChannelsRequest](#onos-e2t-e2-v1beta1-ListChannelsRequest) + - [ListChannelsResponse](#onos-e2t-e2-v1beta1-ListChannelsResponse) + - [ListSubscriptionsRequest](#onos-e2t-e2-v1beta1-ListSubscriptionsRequest) + - [ListSubscriptionsResponse](#onos-e2t-e2-v1beta1-ListSubscriptionsResponse) + - [SubscribeRequest](#onos-e2t-e2-v1beta1-SubscribeRequest) + - [SubscribeResponse](#onos-e2t-e2-v1beta1-SubscribeResponse) + - [Subscription](#onos-e2t-e2-v1beta1-Subscription) + - [SubscriptionEvent](#onos-e2t-e2-v1beta1-SubscriptionEvent) + - [SubscriptionMeta](#onos-e2t-e2-v1beta1-SubscriptionMeta) + - [SubscriptionSpec](#onos-e2t-e2-v1beta1-SubscriptionSpec) + - [SubscriptionStatus](#onos-e2t-e2-v1beta1-SubscriptionStatus) + - [SubsequentAction](#onos-e2t-e2-v1beta1-SubsequentAction) + - [UnsubscribeRequest](#onos-e2t-e2-v1beta1-UnsubscribeRequest) + - [UnsubscribeResponse](#onos-e2t-e2-v1beta1-UnsubscribeResponse) + - [WatchChannelsRequest](#onos-e2t-e2-v1beta1-WatchChannelsRequest) + - [WatchChannelsResponse](#onos-e2t-e2-v1beta1-WatchChannelsResponse) + - [WatchSubscriptionsRequest](#onos-e2t-e2-v1beta1-WatchSubscriptionsRequest) + - [WatchSubscriptionsResponse](#onos-e2t-e2-v1beta1-WatchSubscriptionsResponse) + + - [ActionType](#onos-e2t-e2-v1beta1-ActionType) + - [ChannelEventType](#onos-e2t-e2-v1beta1-ChannelEventType) + - [ChannelPhase](#onos-e2t-e2-v1beta1-ChannelPhase) + - [ChannelState](#onos-e2t-e2-v1beta1-ChannelState) + - [SubscriptionEventType](#onos-e2t-e2-v1beta1-SubscriptionEventType) + - [SubscriptionPhase](#onos-e2t-e2-v1beta1-SubscriptionPhase) + - [SubscriptionState](#onos-e2t-e2-v1beta1-SubscriptionState) + - [SubsequentActionType](#onos-e2t-e2-v1beta1-SubsequentActionType) + - [TimeToWait](#onos-e2t-e2-v1beta1-TimeToWait) + + - [SubscriptionAdminService](#onos-e2t-e2-v1beta1-SubscriptionAdminService) + - [SubscriptionService](#onos-e2t-e2-v1beta1-SubscriptionService) + +- [Scalar Value Types](#scalar-value-types) + + + + + + +## onos/e2t/e2/v1beta1/control.proto + + + + + +### ControlMessage + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| header | [bytes](#bytes) | | | +| payload | [bytes](#bytes) | | | + + + + + + + + +### ControlOutcome + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| payload | [bytes](#bytes) | | | + + + + + + + + +### ControlRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| headers | [RequestHeaders](#onos-e2t-e2-v1beta1-RequestHeaders) | | | +| message | [ControlMessage](#onos-e2t-e2-v1beta1-ControlMessage) | | | +| call_process_id | [bytes](#bytes) | | | + + + + + + + + +### ControlResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| headers | [ResponseHeaders](#onos-e2t-e2-v1beta1-ResponseHeaders) | | | +| outcome | [ControlOutcome](#onos-e2t-e2-v1beta1-ControlOutcome) | | | + + + + + + + + + + + + + + +### ControlService + + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| Control | [ControlRequest](#onos-e2t-e2-v1beta1-ControlRequest) | [ControlResponse](#onos-e2t-e2-v1beta1-ControlResponse) | | + + + + + + + + +## onos/e2t/e2/v1beta1/e2.proto + + + + + +### Error +Error is an E2AP protocol error + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| cause | [Error.Cause](#onos-e2t-e2-v1beta1-Error-Cause) | | | + + + + + + + + +### Error.Cause + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| unknown | [Error.Cause.Unknown](#onos-e2t-e2-v1beta1-Error-Cause-Unknown) | | | +| protocol | [Error.Cause.Protocol](#onos-e2t-e2-v1beta1-Error-Cause-Protocol) | | | +| ric | [Error.Cause.Ric](#onos-e2t-e2-v1beta1-Error-Cause-Ric) | | | +| ric_service | [Error.Cause.RicService](#onos-e2t-e2-v1beta1-Error-Cause-RicService) | | | +| transport | [Error.Cause.Transport](#onos-e2t-e2-v1beta1-Error-Cause-Transport) | | | +| misc | [Error.Cause.Misc](#onos-e2t-e2-v1beta1-Error-Cause-Misc) | | | + + + + + + + + +### Error.Cause.Misc + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| type | [Error.Cause.Misc.Type](#onos-e2t-e2-v1beta1-Error-Cause-Misc-Type) | | | + + + + + + + + +### Error.Cause.Protocol + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| type | [Error.Cause.Protocol.Type](#onos-e2t-e2-v1beta1-Error-Cause-Protocol-Type) | | | + + + + + + + + +### Error.Cause.Ric + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| type | [Error.Cause.Ric.Type](#onos-e2t-e2-v1beta1-Error-Cause-Ric-Type) | | | + + + + + + + + +### Error.Cause.RicService + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| type | [Error.Cause.RicService.Type](#onos-e2t-e2-v1beta1-Error-Cause-RicService-Type) | | | + + + + + + + + +### Error.Cause.Transport + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| type | [Error.Cause.Transport.Type](#onos-e2t-e2-v1beta1-Error-Cause-Transport-Type) | | | + + + + + + + + +### Error.Cause.Unknown + + + + + + + + + +### RequestHeaders + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| app_id | [string](#string) | | | +| app_instance_id | [string](#string) | | | +| e2_node_id | [string](#string) | | | +| service_model | [ServiceModel](#onos-e2t-e2-v1beta1-ServiceModel) | | | +| encoding | [Encoding](#onos-e2t-e2-v1beta1-Encoding) | | | + + + + + + + + +### ResponseHeaders + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| encoding | [Encoding](#onos-e2t-e2-v1beta1-Encoding) | | | + + + + + + + + +### ServiceModel + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | | +| version | [string](#string) | | | + + + + + + + + + + +### Encoding + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| PROTO | 0 | | +| ASN1_PER | 1 | | +| ASN1_XER | 2 | | + + + + + +### Error.Cause.Misc.Type + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| UNSPECIFIED | 0 | | +| CONTROL_PROCESSING_OVERLOAD | 1 | | +| HARDWARE_FAILURE | 2 | | +| OM_INTERVENTION | 3 | | + + + + + +### Error.Cause.Protocol.Type + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| UNSPECIFIED | 0 | | +| TRANSFER_SYNTAX_ERROR | 1 | | +| ABSTRACT_SYNTAX_ERROR_REJECT | 2 | | +| ABSTRACT_SYNTAX_ERROR_IGNORE_AND_NOTIFY | 3 | | +| MESSAGE_NOT_COMPATIBLE_WITH_RECEIVER_STATE | 4 | | +| SEMANTIC_ERROR | 5 | | +| ABSTRACT_SYNTAX_ERROR_FALSELY_CONSTRUCTED_MESSAGE | 6 | | + + + + + +### Error.Cause.Ric.Type + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| UNSPECIFIED | 0 | | +| RAN_FUNCTION_ID_INVALID | 1 | | +| ACTION_NOT_SUPPORTED | 2 | | +| EXCESSIVE_ACTIONS | 3 | | +| DUPLICATE_ACTION | 4 | | +| DUPLICATE_EVENT | 5 | | +| FUNCTION_RESOURCE_LIMIT | 6 | | +| REQUEST_ID_UNKNOWN | 7 | | +| INCONSISTENT_ACTION_SUBSEQUENT_ACTION_SEQUENCE | 8 | | +| CONTROL_MESSAGE_INVALID | 9 | | +| CALL_PROCESS_ID_INVALID | 10 | | +| CONTROL_TIMER_EXPIRED | 11 | | +| CONTROL_FAILED_TO_EXECUTE | 12 | | +| CONTROL_SYSTEM_NOT_READY | 13 | | + + + + + +### Error.Cause.RicService.Type + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| UNSPECIFIED | 0 | | +| FUNCTION_NOT_REQUIRED | 1 | | +| EXCESSIVE_FUNCTIONS | 2 | | +| RIC_RESOURCE_LIMIT | 3 | | + + + + + +### Error.Cause.Transport.Type + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| UNSPECIFIED | 0 | | +| TRANSPORT_RESOURCE_UNAVAILABLE | 1 | | + + + + + + + + + + + + + +## onos/e2t/e2/v1beta1/subscription.proto + + + + + +### Acknowledgement + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| channel_id | [string](#string) | | | + + + + + + + + +### Action + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [int32](#int32) | | | +| type | [ActionType](#onos-e2t-e2-v1beta1-ActionType) | | | +| payload | [bytes](#bytes) | | | +| subsequent_action | [SubsequentAction](#onos-e2t-e2-v1beta1-SubsequentAction) | | | + + + + + + + + +### Channel + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | | +| meta | [ChannelMeta](#onos-e2t-e2-v1beta1-ChannelMeta) | | | +| spec | [ChannelSpec](#onos-e2t-e2-v1beta1-ChannelSpec) | | | +| status | [ChannelStatus](#onos-e2t-e2-v1beta1-ChannelStatus) | | | + + + + + + + + +### ChannelEvent + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| type | [ChannelEventType](#onos-e2t-e2-v1beta1-ChannelEventType) | | | +| channel | [Channel](#onos-e2t-e2-v1beta1-Channel) | | | + + + + + + + + +### ChannelMeta +ChannelMeta contains metadata relating to a subscription channel + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| app_id | [string](#string) | | app_id is an identifier for the application that created the channel shared across all instances of the application | +| app_instance_id | [string](#string) | | app_instance_id is an identifier unique to a single node within the application that created the channel | +| e2_node_id | [string](#string) | | e2_node_id is the identifier for the E2 node to which the subscription is targeted | +| transaction_id | [string](#string) | | transaction_id is a persistent identifier for the transaction | +| subscription_id | [string](#string) | | subscription_id is the identifier for the underlying subscription | +| service_model | [ServiceModel](#onos-e2t-e2-v1beta1-ServiceModel) | | service_model is the service model specification | +| encoding | [Encoding](#onos-e2t-e2-v1beta1-Encoding) | | encoding indicates the type of encoding used within the parent message | +| revision | [uint64](#uint64) | | | +| finalizers | [string](#string) | repeated | | + + + + + + + + +### ChannelSpec + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| subscription | [SubscriptionSpec](#onos-e2t-e2-v1beta1-SubscriptionSpec) | | | +| transaction_timeout | [google.protobuf.Duration](#google-protobuf-Duration) | | | + + + + + + + + +### ChannelStatus + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| phase | [ChannelPhase](#onos-e2t-e2-v1beta1-ChannelPhase) | | | +| state | [ChannelState](#onos-e2t-e2-v1beta1-ChannelState) | | | +| error | [Error](#onos-e2t-e2-v1beta1-Error) | | | +| timestamp | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | | +| term | [uint64](#uint64) | | | +| master | [string](#string) | | | + + + + + + + + +### EventTrigger + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| payload | [bytes](#bytes) | | | + + + + + + + + +### GetChannelRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| channel_id | [string](#string) | | | + + + + + + + + +### GetChannelResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| channel | [Channel](#onos-e2t-e2-v1beta1-Channel) | | | + + + + + + + + +### GetSubscriptionRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| subscription_id | [string](#string) | | | + + + + + + + + +### GetSubscriptionResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| subscription | [Subscription](#onos-e2t-e2-v1beta1-Subscription) | | | + + + + + + + + +### Indication + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| header | [bytes](#bytes) | | | +| payload | [bytes](#bytes) | | | +| call_process_id | [bytes](#bytes) | | | + + + + + + + + +### ListChannelsRequest + + + + + + + + + +### ListChannelsResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| channels | [Channel](#onos-e2t-e2-v1beta1-Channel) | repeated | | + + + + + + + + +### ListSubscriptionsRequest + + + + + + + + + +### ListSubscriptionsResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| subscriptions | [Subscription](#onos-e2t-e2-v1beta1-Subscription) | repeated | | + + + + + + + + +### SubscribeRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| headers | [RequestHeaders](#onos-e2t-e2-v1beta1-RequestHeaders) | | | +| transaction_id | [string](#string) | | | +| subscription | [SubscriptionSpec](#onos-e2t-e2-v1beta1-SubscriptionSpec) | | | +| transaction_timeout | [google.protobuf.Duration](#google-protobuf-Duration) | | | + + + + + + + + +### SubscribeResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| headers | [ResponseHeaders](#onos-e2t-e2-v1beta1-ResponseHeaders) | | | +| ack | [Acknowledgement](#onos-e2t-e2-v1beta1-Acknowledgement) | | | +| indication | [Indication](#onos-e2t-e2-v1beta1-Indication) | | | + + + + + + + + +### Subscription + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | | +| meta | [SubscriptionMeta](#onos-e2t-e2-v1beta1-SubscriptionMeta) | | | +| spec | [SubscriptionSpec](#onos-e2t-e2-v1beta1-SubscriptionSpec) | | | +| status | [SubscriptionStatus](#onos-e2t-e2-v1beta1-SubscriptionStatus) | | | + + + + + + + + +### SubscriptionEvent + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| type | [SubscriptionEventType](#onos-e2t-e2-v1beta1-SubscriptionEventType) | | | +| subscription | [Subscription](#onos-e2t-e2-v1beta1-Subscription) | | | + + + + + + + + +### SubscriptionMeta + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| e2_node_id | [string](#string) | | | +| service_model | [ServiceModel](#onos-e2t-e2-v1beta1-ServiceModel) | | | +| encoding | [Encoding](#onos-e2t-e2-v1beta1-Encoding) | | | +| revision | [uint64](#uint64) | | | +| finalizers | [string](#string) | repeated | | + + + + + + + + +### SubscriptionSpec + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| event_trigger | [EventTrigger](#onos-e2t-e2-v1beta1-EventTrigger) | | | +| actions | [Action](#onos-e2t-e2-v1beta1-Action) | repeated | | + + + + + + + + +### SubscriptionStatus + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| phase | [SubscriptionPhase](#onos-e2t-e2-v1beta1-SubscriptionPhase) | | | +| state | [SubscriptionState](#onos-e2t-e2-v1beta1-SubscriptionState) | | | +| error | [Error](#onos-e2t-e2-v1beta1-Error) | | | +| channels | [string](#string) | repeated | | +| term | [uint64](#uint64) | | | +| master | [string](#string) | | | + + + + + + + + +### SubsequentAction + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| type | [SubsequentActionType](#onos-e2t-e2-v1beta1-SubsequentActionType) | | | +| time_to_wait | [TimeToWait](#onos-e2t-e2-v1beta1-TimeToWait) | | | + + + + + + + + +### UnsubscribeRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| headers | [RequestHeaders](#onos-e2t-e2-v1beta1-RequestHeaders) | | | +| transaction_id | [string](#string) | | | + + + + + + + + +### UnsubscribeResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| headers | [ResponseHeaders](#onos-e2t-e2-v1beta1-ResponseHeaders) | | | + + + + + + + + +### WatchChannelsRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| no_replay | [bool](#bool) | | | + + + + + + + + +### WatchChannelsResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| event | [ChannelEvent](#onos-e2t-e2-v1beta1-ChannelEvent) | | | + + + + + + + + +### WatchSubscriptionsRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| no_replay | [bool](#bool) | | | + + + + + + + + +### WatchSubscriptionsResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| event | [SubscriptionEvent](#onos-e2t-e2-v1beta1-SubscriptionEvent) | | | + + + + + + + + + + +### ActionType + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| ACTION_TYPE_REPORT | 0 | | +| ACTION_TYPE_INSERT | 1 | | +| ACTION_TYPE_POLICY | 2 | | + + + + + +### ChannelEventType + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| CHANNEL_EVENT_UNKNOWN | 0 | | +| CHANNEL_CREATED | 1 | | +| CHANNEL_UPDATED | 2 | | +| CHANNEL_DELETED | 3 | | +| CHANNEL_REPLAYED | 4 | | + + + + + +### ChannelPhase + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| CHANNEL_CLOSED | 0 | | +| CHANNEL_OPEN | 1 | | + + + + + +### ChannelState + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| CHANNEL_PENDING | 0 | CHANNEL_PENDING indicates the channel phase is pending | +| CHANNEL_COMPLETE | 1 | CHANNEL_COMPLETE indicates the channel phase is complete | +| CHANNEL_FAILED | 2 | CHANNEL_FAILED indicates the channel phase failed | + + + + + +### SubscriptionEventType + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| SUBSCRIPTION_EVENT_UNKNOWN | 0 | | +| SUBSCRIPTION_CREATED | 1 | | +| SUBSCRIPTION_UPDATED | 2 | | +| SUBSCRIPTION_DELETED | 3 | | +| SUBSCRIPTION_REPLAYED | 4 | | + + + + + +### SubscriptionPhase + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| SUBSCRIPTION_CLOSED | 0 | | +| SUBSCRIPTION_OPEN | 1 | | + + + + + +### SubscriptionState + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| SUBSCRIPTION_PENDING | 0 | SUBSCRIPTION_PENDING indicates the subscription phase is pending | +| SUBSCRIPTION_COMPLETE | 1 | SUBSCRIPTION_COMPLETE indicates the subscription phase is complete | +| SUBSCRIPTION_FAILED | 2 | SUBSCRIPTION_FAILED indicates the subscription phase failed | + + + + + +### SubsequentActionType + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| SUBSEQUENT_ACTION_TYPE_CONTINUE | 0 | | +| SUBSEQUENT_ACTION_TYPE_WAIT | 1 | | + + + + + +### TimeToWait + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| TIME_TO_WAIT_ZERO | 0 | | +| TIME_TO_WAIT_W1MS | 1 | | +| TIME_TO_WAIT_W2MS | 2 | | +| TIME_TO_WAIT_W5MS | 3 | | +| TIME_TO_WAIT_W10MS | 4 | | +| TIME_TO_WAIT_W20MS | 5 | | +| TIME_TO_WAIT_W30MS | 6 | | +| TIME_TO_WAIT_W40MS | 7 | | +| TIME_TO_WAIT_W50MS | 8 | | +| TIME_TO_WAIT_W100MS | 9 | | +| TIME_TO_WAIT_W200MS | 10 | | +| TIME_TO_WAIT_W500MS | 11 | | +| TIME_TO_WAIT_W1S | 12 | | +| TIME_TO_WAIT_W2S | 13 | | +| TIME_TO_WAIT_W5S | 14 | | +| TIME_TO_WAIT_W10S | 15 | | +| TIME_TO_WAIT_W20S | 16 | | +| TIME_TO_WAIT_W60S | 17 | | + + + + + + + + + +### SubscriptionAdminService + + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| GetChannel | [GetChannelRequest](#onos-e2t-e2-v1beta1-GetChannelRequest) | [GetChannelResponse](#onos-e2t-e2-v1beta1-GetChannelResponse) | | +| ListChannels | [ListChannelsRequest](#onos-e2t-e2-v1beta1-ListChannelsRequest) | [ListChannelsResponse](#onos-e2t-e2-v1beta1-ListChannelsResponse) | | +| WatchChannels | [WatchChannelsRequest](#onos-e2t-e2-v1beta1-WatchChannelsRequest) | [WatchChannelsResponse](#onos-e2t-e2-v1beta1-WatchChannelsResponse) stream | | +| GetSubscription | [GetSubscriptionRequest](#onos-e2t-e2-v1beta1-GetSubscriptionRequest) | [GetSubscriptionResponse](#onos-e2t-e2-v1beta1-GetSubscriptionResponse) | | +| ListSubscriptions | [ListSubscriptionsRequest](#onos-e2t-e2-v1beta1-ListSubscriptionsRequest) | [ListSubscriptionsResponse](#onos-e2t-e2-v1beta1-ListSubscriptionsResponse) | | +| WatchSubscriptions | [WatchSubscriptionsRequest](#onos-e2t-e2-v1beta1-WatchSubscriptionsRequest) | [WatchSubscriptionsResponse](#onos-e2t-e2-v1beta1-WatchSubscriptionsResponse) stream | | + + + + +### SubscriptionService + + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| Subscribe | [SubscribeRequest](#onos-e2t-e2-v1beta1-SubscribeRequest) | [SubscribeResponse](#onos-e2t-e2-v1beta1-SubscribeResponse) stream | | +| Unsubscribe | [UnsubscribeRequest](#onos-e2t-e2-v1beta1-UnsubscribeRequest) | [UnsubscribeResponse](#onos-e2t-e2-v1beta1-UnsubscribeResponse) | | + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | 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 | int32 | int | integer | Bignum or Fixnum (as required) | +| 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 | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/onos-api/docs/onos/fabricsim/devices.md b/onos-api/docs/onos/fabricsim/devices.md new file mode 100644 index 0000000..1691b9d --- /dev/null +++ b/onos-api/docs/onos/fabricsim/devices.md @@ -0,0 +1,432 @@ +# Protocol Documentation + + +## Table of Contents + +- [onos/fabricsim/devices.proto](#onos_fabricsim_devices-proto) + - [AddDeviceRequest](#onos-fabricsim-AddDeviceRequest) + - [AddDeviceResponse](#onos-fabricsim-AddDeviceResponse) + - [Device](#onos-fabricsim-Device) + - [DisablePortRequest](#onos-fabricsim-DisablePortRequest) + - [DisablePortResponse](#onos-fabricsim-DisablePortResponse) + - [EmitLLDPPacketRequest](#onos-fabricsim-EmitLLDPPacketRequest) + - [EmitLLDPPacketResponse](#onos-fabricsim-EmitLLDPPacketResponse) + - [EnablePortRequest](#onos-fabricsim-EnablePortRequest) + - [EnablePortResponse](#onos-fabricsim-EnablePortResponse) + - [EntitiesInfo](#onos-fabricsim-EntitiesInfo) + - [GetDeviceRequest](#onos-fabricsim-GetDeviceRequest) + - [GetDeviceResponse](#onos-fabricsim-GetDeviceResponse) + - [GetDevicesRequest](#onos-fabricsim-GetDevicesRequest) + - [GetDevicesResponse](#onos-fabricsim-GetDevicesResponse) + - [PipelineInfo](#onos-fabricsim-PipelineInfo) + - [Port](#onos-fabricsim-Port) + - [RemoveDeviceRequest](#onos-fabricsim-RemoveDeviceRequest) + - [RemoveDeviceResponse](#onos-fabricsim-RemoveDeviceResponse) + - [StartDeviceRequest](#onos-fabricsim-StartDeviceRequest) + - [StartDeviceResponse](#onos-fabricsim-StartDeviceResponse) + - [StopDeviceRequest](#onos-fabricsim-StopDeviceRequest) + - [StopDeviceResponse](#onos-fabricsim-StopDeviceResponse) + + - [DeviceType](#onos-fabricsim-DeviceType) + - [StopMode](#onos-fabricsim-StopMode) + + - [DeviceService](#onos-fabricsim-DeviceService) + +- [Scalar Value Types](#scalar-value-types) + + + + + + +## onos/fabricsim/devices.proto + + + + + +### AddDeviceRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| device | [Device](#onos-fabricsim-Device) | | | + + + + + + + + +### AddDeviceResponse + + + + + + + + + +### Device +Device describes a simulated switch or IPU + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | unique device id and device type | +| type | [DeviceType](#onos-fabricsim-DeviceType) | | | +| ports | [Port](#onos-fabricsim-Port) | repeated | list of ports | +| control_port | [int32](#int32) | | control port for p4 and gnmi simulation | +| chassis_id | [uint64](#uint64) | | unique chassis ID | +| pipeline_info | [PipelineInfo](#onos-fabricsim-PipelineInfo) | | forwarding pipeline information | +| pos | [onos.misc.GridPosition](#onos-misc-GridPosition) | | Screen coordinates | +| connections | [onos.misc.Connection](#onos-misc-Connection) | repeated | Current connections and total connection count | +| total_connections | [int32](#int32) | | | +| io_stats | [onos.misc.IOStats](#onos-misc-IOStats) | | Cumulative I/O stats for the device P4Runtime, gNMI and gNOI agent(s) | + + + + + + + + +### DisablePortRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | | +| mode | [StopMode](#onos-fabricsim-StopMode) | | | + + + + + + + + +### DisablePortResponse + + + + + + + + + +### EmitLLDPPacketRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| port_id | [string](#string) | | | +| packet | [bytes](#bytes) | | | + + + + + + + + +### EmitLLDPPacketResponse + + + + + + + + + +### EnablePortRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | | + + + + + + + + +### EnablePortResponse + + + + + + + + + +### EntitiesInfo +EntitiesInfo provides information about size of pipeline entities, tables, meters, counters + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [uint32](#uint32) | | | +| size | [uint32](#uint32) | | | +| name | [string](#string) | | | + + + + + + + + +### GetDeviceRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | | + + + + + + + + +### GetDeviceResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| device | [Device](#onos-fabricsim-Device) | | | + + + + + + + + +### GetDevicesRequest +filters? + + + + + + + + +### GetDevicesResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| devices | [Device](#onos-fabricsim-Device) | repeated | | + + + + + + + + +### PipelineInfo +PipelineInfo provides information about the currently deployed forwarding pipeline + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| cookie | [uint64](#uint64) | | | +| p4_info | [bytes](#bytes) | | | +| tables | [EntitiesInfo](#onos-fabricsim-EntitiesInfo) | repeated | summary information about tables, counters, meters, groups, etc. | +| counters | [EntitiesInfo](#onos-fabricsim-EntitiesInfo) | repeated | | +| meters | [EntitiesInfo](#onos-fabricsim-EntitiesInfo) | repeated | | +| groups | [EntitiesInfo](#onos-fabricsim-EntitiesInfo) | repeated | | +| multicast_groups | [EntitiesInfo](#onos-fabricsim-EntitiesInfo) | repeated | | +| clone_sessions | [EntitiesInfo](#onos-fabricsim-EntitiesInfo) | repeated | | + + + + + + + + +### Port +Port describes a simulated device port + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | unique port id and port type | +| name | [string](#string) | | display/friendly name | +| number | [uint32](#uint32) | | port number | +| internal_number | [uint32](#uint32) | | sdn/internal port number | +| speed | [string](#string) | | speed and status | +| enabled | [bool](#bool) | | | + + + + + + + + +### RemoveDeviceRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | | + + + + + + + + +### RemoveDeviceResponse + + + + + + + + + +### StartDeviceRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | | + + + + + + + + +### StartDeviceResponse + + + + + + + + + +### StopDeviceRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | | +| mode | [StopMode](#onos-fabricsim-StopMode) | | | + + + + + + + + +### StopDeviceResponse + + + + + + + + + + + +### DeviceType +DeviceType represents type of a device, i.e. switch, IPU, etc. + +| Name | Number | Description | +| ---- | ------ | ----------- | +| SWITCH | 0 | default assumption | +| IPU | 1 | | + + + + + +### StopMode +StopMode indicates whether to simulate orderly (administrative) or chaotic (power off) shutdown + +| Name | Number | Description | +| ---- | ------ | ----------- | +| ORDERLY_STOP | 0 | | +| CHAOTIC_STOP | 1 | | + + + + + + + + + +### DeviceService +DeviceService provides means to control inventory of simulated devices (switches and IPUs) and their ports + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| GetDevices | [GetDevicesRequest](#onos-fabricsim-GetDevicesRequest) | [GetDevicesResponse](#onos-fabricsim-GetDevicesResponse) | GetDevices gets a list of all simulated devices (switches and/or IPUs) | +| GetDevice | [GetDeviceRequest](#onos-fabricsim-GetDeviceRequest) | [GetDeviceResponse](#onos-fabricsim-GetDeviceResponse) | GetDevice gets a specific device entry | +| AddDevice | [AddDeviceRequest](#onos-fabricsim-AddDeviceRequest) | [AddDeviceResponse](#onos-fabricsim-AddDeviceResponse) | AddDevice creates a new simulated deviceand start its P4Runtime and gNMI services | +| RemoveDevice | [RemoveDeviceRequest](#onos-fabricsim-RemoveDeviceRequest) | [RemoveDeviceResponse](#onos-fabricsim-RemoveDeviceResponse) | RemoveDevice removes a simulated device | +| StopDevice | [StopDeviceRequest](#onos-fabricsim-StopDeviceRequest) | [StopDeviceResponse](#onos-fabricsim-StopDeviceResponse) | StopDevice stops the simulated deviceP4Runtime and gNMI services | +| StartDevice | [StartDeviceRequest](#onos-fabricsim-StartDeviceRequest) | [StartDeviceResponse](#onos-fabricsim-StartDeviceResponse) | StartDevice starts the simulated deviceP4Runtime and gNMI services | +| DisablePort | [DisablePortRequest](#onos-fabricsim-DisablePortRequest) | [DisablePortResponse](#onos-fabricsim-DisablePortResponse) | DisablePort disables the specified port | +| EnablePort | [EnablePortRequest](#onos-fabricsim-EnablePortRequest) | [EnablePortResponse](#onos-fabricsim-EnablePortResponse) | EnablePort enables the specified port | +| EmitLLDPPacket | [EmitLLDPPacketRequest](#onos-fabricsim-EmitLLDPPacketRequest) | [EmitLLDPPacketResponse](#onos-fabricsim-EmitLLDPPacketResponse) | EmitLLDPPacket emits the specified LLDP packet on a given device port. | + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | 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 | int32 | int | integer | Bignum or Fixnum (as required) | +| 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 | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/onos-api/docs/onos/fabricsim/hosts.md b/onos-api/docs/onos/fabricsim/hosts.md new file mode 100644 index 0000000..765034a --- /dev/null +++ b/onos-api/docs/onos/fabricsim/hosts.md @@ -0,0 +1,275 @@ +# Protocol Documentation + + +## Table of Contents + +- [onos/fabricsim/hosts.proto](#onos_fabricsim_hosts-proto) + - [AddHostRequest](#onos-fabricsim-AddHostRequest) + - [AddHostResponse](#onos-fabricsim-AddHostResponse) + - [EmitARPsRequest](#onos-fabricsim-EmitARPsRequest) + - [EmitARPsResponse](#onos-fabricsim-EmitARPsResponse) + - [GetHostRequest](#onos-fabricsim-GetHostRequest) + - [GetHostResponse](#onos-fabricsim-GetHostResponse) + - [GetHostsRequest](#onos-fabricsim-GetHostsRequest) + - [GetHostsResponse](#onos-fabricsim-GetHostsResponse) + - [Host](#onos-fabricsim-Host) + - [NetworkInterface](#onos-fabricsim-NetworkInterface) + - [NetworkInterfaceBehavior](#onos-fabricsim-NetworkInterfaceBehavior) + - [RemoveHostRequest](#onos-fabricsim-RemoveHostRequest) + - [RemoveHostResponse](#onos-fabricsim-RemoveHostResponse) + + - [HostType](#onos-fabricsim-HostType) + + - [HostService](#onos-fabricsim-HostService) + +- [Scalar Value Types](#scalar-value-types) + + + + + + +## onos/fabricsim/hosts.proto + + + + + +### AddHostRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| host | [Host](#onos-fabricsim-Host) | | | +| hosted_by | [string](#string) | | | + + + + + + + + +### AddHostResponse + + + + + + + + + +### EmitARPsRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | | +| mac_address | [string](#string) | | | +| ip_addresses | [string](#string) | repeated | | + + + + + + + + +### EmitARPsResponse + + + + + + + + + +### GetHostRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | | + + + + + + + + +### GetHostResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| host | [Host](#onos-fabricsim-Host) | | | + + + + + + + + +### GetHostsRequest +filters? + + + + + + + + +### GetHostsResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| hosts | [Host](#onos-fabricsim-Host) | repeated | | + + + + + + + + +### Host +Host describes a simulated host (bare metal, VM or container) + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | unique host id and host type | +| type | [HostType](#onos-fabricsim-HostType) | | | +| interfaces | [NetworkInterface](#onos-fabricsim-NetworkInterface) | repeated | network interfaces | +| pos | [onos.misc.GridPosition](#onos-misc-GridPosition) | | | +| hosts | [Host](#onos-fabricsim-Host) | repeated | virtual hosts being hosted by this (bare metal) host | + + + + + + + + +### NetworkInterface +NetworkInterface describes simulated host's attachment to the network + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | unique port id | +| mac_address | [string](#string) | | mac address and VLAN | +| vlan | [uint32](#uint32) | | | +| ip_address | [string](#string) | | ipv4 address | +| ipv6_address | [string](#string) | | ipv6 address | +| behavior | [NetworkInterfaceBehavior](#onos-fabricsim-NetworkInterfaceBehavior) | | behavior | + + + + + + + + +### NetworkInterfaceBehavior +NetworkInterfaceBehavior describes dynamic aspects of a simulated host interface +and how it manifests its presence on the network. + +TBD + + + + + + + + +### RemoveHostRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | | + + + + + + + + +### RemoveHostResponse + + + + + + + + + + + +### HostType +HostType represents type of a host, i.e. bare metal, virtual, etc. + +| Name | Number | Description | +| ---- | ------ | ----------- | +| BARE_METAL | 0 | default assumption | +| VIRTUAL | 1 | | + + + + + + + + + +### HostService +HostService provides means to control inventory of simulated hosts + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| GetHosts | [GetHostsRequest](#onos-fabricsim-GetHostsRequest) | [GetHostsResponse](#onos-fabricsim-GetHostsResponse) | GetHosts gets a list of all simulated hosts | +| GetHost | [GetHostRequest](#onos-fabricsim-GetHostRequest) | [GetHostResponse](#onos-fabricsim-GetHostResponse) | GetHost gets a specific host entry | +| AddHost | [AddHostRequest](#onos-fabricsim-AddHostRequest) | [AddHostResponse](#onos-fabricsim-AddHostResponse) | AddHost adds a new simulated host | +| RemoveHost | [RemoveHostRequest](#onos-fabricsim-RemoveHostRequest) | [RemoveHostResponse](#onos-fabricsim-RemoveHostResponse) | RemoveHost removes a simulated host | +| EmitARPs | [EmitARPsRequest](#onos-fabricsim-EmitARPsRequest) | [EmitARPsResponse](#onos-fabricsim-EmitARPsResponse) | EmitARPs triggers the specified host NIC to send ARP requests for a set of IP addresses | + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | 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 | int32 | int | integer | Bignum or Fixnum (as required) | +| 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 | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/onos-api/docs/onos/fabricsim/links.md b/onos-api/docs/onos/fabricsim/links.md new file mode 100644 index 0000000..76339e6 --- /dev/null +++ b/onos-api/docs/onos/fabricsim/links.md @@ -0,0 +1,210 @@ +# Protocol Documentation + + +## Table of Contents + +- [onos/fabricsim/links.proto](#onos_fabricsim_links-proto) + - [AddLinkRequest](#onos-fabricsim-AddLinkRequest) + - [AddLinkResponse](#onos-fabricsim-AddLinkResponse) + - [GetLinkRequest](#onos-fabricsim-GetLinkRequest) + - [GetLinkResponse](#onos-fabricsim-GetLinkResponse) + - [GetLinksRequest](#onos-fabricsim-GetLinksRequest) + - [GetLinksResponse](#onos-fabricsim-GetLinksResponse) + - [Link](#onos-fabricsim-Link) + - [RemoveLinkRequest](#onos-fabricsim-RemoveLinkRequest) + - [RemoveLinkResponse](#onos-fabricsim-RemoveLinkResponse) + + - [LinkStatus](#onos-fabricsim-LinkStatus) + + - [LinkService](#onos-fabricsim-LinkService) + +- [Scalar Value Types](#scalar-value-types) + + + + + + +## onos/fabricsim/links.proto + + + + + +### AddLinkRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| link | [Link](#onos-fabricsim-Link) | | | + + + + + + + + +### AddLinkResponse + + + + + + + + + +### GetLinkRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | | + + + + + + + + +### GetLinkResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| link | [Link](#onos-fabricsim-Link) | | | + + + + + + + + +### GetLinksRequest +filters? + + + + + + + + +### GetLinksResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| links | [Link](#onos-fabricsim-Link) | repeated | | + + + + + + + + +### Link +Link describes a simulated link, i.e a link between two device or host ports + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | unique port id and port type | +| src_id | [string](#string) | | unique port ids of source and target ports | +| tgt_id | [string](#string) | | | +| status | [LinkStatus](#onos-fabricsim-LinkStatus) | | status (operational state derived from the status of its adjacent ports) + +read-only entity | + + + + + + + + +### RemoveLinkRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | | + + + + + + + + +### RemoveLinkResponse + + + + + + + + + + + +### LinkStatus +LinkStatus represents the operational status of the link, derived from the status of its adjacent ports + +| Name | Number | Description | +| ---- | ------ | ----------- | +| LINK_DOWN | 0 | | +| LINK_UP | 1 | | + + + + + + + + + +### LinkService +LinkService provides means to control inventory of simulated links + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| GetLinks | [GetLinksRequest](#onos-fabricsim-GetLinksRequest) | [GetLinksResponse](#onos-fabricsim-GetLinksResponse) | GetLinks gets a list of all simulated links | +| GetLink | [GetLinkRequest](#onos-fabricsim-GetLinkRequest) | [GetLinkResponse](#onos-fabricsim-GetLinkResponse) | GetLink gets a specific link entry | +| AddLink | [AddLinkRequest](#onos-fabricsim-AddLinkRequest) | [AddLinkResponse](#onos-fabricsim-AddLinkResponse) | AddLink adds a new simulated link | +| RemoveLink | [RemoveLinkRequest](#onos-fabricsim-RemoveLinkRequest) | [RemoveLinkResponse](#onos-fabricsim-RemoveLinkResponse) | RemoveLink removes a simulated link | + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | 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 | int32 | int | integer | Bignum or Fixnum (as required) | +| 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 | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/onos-api/docs/onos/fabricsim/types.md b/onos-api/docs/onos/fabricsim/types.md new file mode 100644 index 0000000..51fa5bb --- /dev/null +++ b/onos-api/docs/onos/fabricsim/types.md @@ -0,0 +1,142 @@ +# Protocol Documentation + + +## Table of Contents + +- [onos/fabricsim/types.proto](#onos_fabricsim_types-proto) + - [Device](#onos-fabricsim-Device) + - [Host](#onos-fabricsim-Host) + - [Link](#onos-fabricsim-Link) + - [NetworkInterface](#onos-fabricsim-NetworkInterface) + - [NetworkInterfaceBehavior](#onos-fabricsim-NetworkInterfaceBehavior) + - [Port](#onos-fabricsim-Port) + +- [Scalar Value Types](#scalar-value-types) + + + + + + +## onos/fabricsim/types.proto + + + + + +### Device +Device describes a simulated switch or IPU + +unique_id +type - switch, IPU, etc. +p4_port +gnmi_port +list of ports +behavior? +gnmi models + + + + + + + + +### Host +Host describes a simulated host (bare metal, VM or container) + +network interfaces + + + + + + + + +### Link +Link describes a simulated interdevice link, i.e a link between two device ports + +source port unique id +destination port unique id +status (operational state derived from adjacent ports status) + + + + + + + + +### NetworkInterface +NetworkInterface describes simulated host's attachment to the network + +mac address +ipv4 address +ipv6 address +behavior + + + + + + + + +### NetworkInterfaceBehavior +NetworkInterfaceBehavior describes dynamic aspects of a simulated host interface +and how it manifests its presence on the network. + + + + + + + + +### Port +Port describes a simulated device port + +unique_id +type? +name +port number +sdn port number +speed +p4 behaviors? (counters, etc.) +gnmi behaviors? (counters, etc.) + + + + + + + + + + + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | 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 | int32 | int | integer | Bignum or Fixnum (as required) | +| 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 | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/onos-api/docs/onos/kpimon/kpimon.md b/onos-api/docs/onos/kpimon/kpimon.md new file mode 100644 index 0000000..fb58e01 --- /dev/null +++ b/onos-api/docs/onos/kpimon/kpimon.md @@ -0,0 +1,202 @@ +# Protocol Documentation + + +## Table of Contents + +- [onos/kpimon/kpimon.proto](#onos_kpimon_kpimon-proto) + - [GetRequest](#onos-kpimon-GetRequest) + - [GetResponse](#onos-kpimon-GetResponse) + - [GetResponse.MeasurementsEntry](#onos-kpimon-GetResponse-MeasurementsEntry) + - [IntegerValue](#onos-kpimon-IntegerValue) + - [MeasurementItem](#onos-kpimon-MeasurementItem) + - [MeasurementItems](#onos-kpimon-MeasurementItems) + - [MeasurementRecord](#onos-kpimon-MeasurementRecord) + - [NoValue](#onos-kpimon-NoValue) + - [RealValue](#onos-kpimon-RealValue) + + - [Kpimon](#onos-kpimon-Kpimon) + +- [Scalar Value Types](#scalar-value-types) + + + + + + +## onos/kpimon/kpimon.proto + + + + + +### GetRequest + + + + + + + + + +### GetResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| measurements | [GetResponse.MeasurementsEntry](#onos-kpimon-GetResponse-MeasurementsEntry) | repeated | | + + + + + + + + +### GetResponse.MeasurementsEntry + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [MeasurementItems](#onos-kpimon-MeasurementItems) | | | + + + + + + + + +### IntegerValue + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| value | [int64](#int64) | | | + + + + + + + + +### MeasurementItem + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| measurement_records | [MeasurementRecord](#onos-kpimon-MeasurementRecord) | repeated | | + + + + + + + + +### MeasurementItems + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| measurement_items | [MeasurementItem](#onos-kpimon-MeasurementItem) | repeated | | + + + + + + + + +### MeasurementRecord + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| timestamp | [uint64](#uint64) | | | +| measurement_name | [string](#string) | | | +| measurement_value | [google.protobuf.Any](#google-protobuf-Any) | | | + + + + + + + + +### NoValue + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| value | [int32](#int32) | | | + + + + + + + + +### RealValue + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| value | [double](#double) | | | + + + + + + + + + + + + + + +### Kpimon + + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| ListMeasurements | [GetRequest](#onos-kpimon-GetRequest) | [GetResponse](#onos-kpimon-GetResponse) | | +| WatchMeasurements | [GetRequest](#onos-kpimon-GetRequest) | [GetResponse](#onos-kpimon-GetResponse) stream | | + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | 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 | int32 | int | integer | Bignum or Fixnum (as required) | +| 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 | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/onos-api/docs/onos/misc/misc.md b/onos-api/docs/onos/misc/misc.md new file mode 100644 index 0000000..187f143 --- /dev/null +++ b/onos-api/docs/onos/misc/misc.md @@ -0,0 +1,103 @@ +# Protocol Documentation + + +## Table of Contents + +- [onos/misc/misc.proto](#onos_misc_misc-proto) + - [Connection](#onos-misc-Connection) + - [GridPosition](#onos-misc-GridPosition) + - [IOStats](#onos-misc-IOStats) + +- [Scalar Value Types](#scalar-value-types) + + + + + + +## onos/misc/misc.proto + + + + + +### Connection +Connection contains information about a single gRPC client connection + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| from_address | [string](#string) | | | +| protocol | [string](#string) | | | +| time | [int64](#int64) | | | + + + + + + + + +### GridPosition +GridPosition indicates where on a grid an entity should be located; used for visualization purposes + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| x | [int32](#int32) | | | +| y | [int32](#int32) | | | + + + + + + + + +### IOStats +IOStats represents I/O statistics for a single device agent + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| in_bytes | [uint32](#uint32) | | | +| in_messages | [uint32](#uint32) | | | +| out_bytes | [uint32](#uint32) | | | +| out_messages | [uint32](#uint32) | | | +| first_update_time | [uint64](#uint64) | | | +| last_update_time | [uint64](#uint64) | | | + + + + + + + + + + + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | 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 | int32 | int | integer | Bignum or Fixnum (as required) | +| 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 | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/onos-api/docs/onos/mlb/mlb.md b/onos-api/docs/onos/mlb/mlb.md new file mode 100644 index 0000000..6205148 --- /dev/null +++ b/onos-api/docs/onos/mlb/mlb.md @@ -0,0 +1,214 @@ +# Protocol Documentation + + +## Table of Contents + +- [onos/mlb/mlb.proto](#onos_mlb_mlb-proto) + - [GetMlbParamRequest](#onos-mlb-GetMlbParamRequest) + - [GetMlbParamResponse](#onos-mlb-GetMlbParamResponse) + - [GetOcnRequest](#onos-mlb-GetOcnRequest) + - [GetOcnResponse](#onos-mlb-GetOcnResponse) + - [GetOcnResponse.OcnMapEntry](#onos-mlb-GetOcnResponse-OcnMapEntry) + - [OcnIDs](#onos-mlb-OcnIDs) + - [OcnRecord](#onos-mlb-OcnRecord) + - [OcnRecord.OcnRecordEntry](#onos-mlb-OcnRecord-OcnRecordEntry) + - [SetMlbParamRequest](#onos-mlb-SetMlbParamRequest) + - [SetMlbParamResponse](#onos-mlb-SetMlbParamResponse) + + - [Mlb](#onos-mlb-Mlb) + +- [Scalar Value Types](#scalar-value-types) + + + + + + +## onos/mlb/mlb.proto + + + + + +### GetMlbParamRequest + + + + + + + + + +### GetMlbParamResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| interval | [int32](#int32) | | | +| overload_threshold | [int32](#int32) | | | +| target_threshold | [int32](#int32) | | | +| delta_ocn | [int32](#int32) | | | + + + + + + + + +### GetOcnRequest + + + + + + + + + +### GetOcnResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| ocn_map | [GetOcnResponse.OcnMapEntry](#onos-mlb-GetOcnResponse-OcnMapEntry) | repeated | | + + + + + + + + +### GetOcnResponse.OcnMapEntry + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [OcnRecord](#onos-mlb-OcnRecord) | | | + + + + + + + + +### OcnIDs + + + + + + + + + +### OcnRecord + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| ocn_record | [OcnRecord.OcnRecordEntry](#onos-mlb-OcnRecord-OcnRecordEntry) | repeated | | + + + + + + + + +### OcnRecord.OcnRecordEntry + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [int32](#int32) | | | + + + + + + + + +### SetMlbParamRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| interval | [int32](#int32) | | | +| overload_threshold | [int32](#int32) | | | +| target_threshold | [int32](#int32) | | | +| delta_ocn | [int32](#int32) | | | + + + + + + + + +### SetMlbParamResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| success | [bool](#bool) | | | + + + + + + + + + + + + + + +### Mlb + + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| GetMlbParams | [GetMlbParamRequest](#onos-mlb-GetMlbParamRequest) | [GetMlbParamResponse](#onos-mlb-GetMlbParamResponse) | GetMlbParams gets MLB parameters | +| SetMlbParams | [SetMlbParamRequest](#onos-mlb-SetMlbParamRequest) | [SetMlbParamResponse](#onos-mlb-SetMlbParamResponse) | SetMlbParams sets MLB parameters | +| GetOcn | [GetOcnRequest](#onos-mlb-GetOcnRequest) | [GetOcnResponse](#onos-mlb-GetOcnResponse) | GetOcn gets Ocn map | + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | 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 | int32 | int | integer | Bignum or Fixnum (as required) | +| 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 | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/onos-api/docs/onos/p4rt/pipeline_config.md b/onos-api/docs/onos/p4rt/pipeline_config.md new file mode 100644 index 0000000..0e8a243 --- /dev/null +++ b/onos-api/docs/onos/p4rt/pipeline_config.md @@ -0,0 +1,202 @@ +# Protocol Documentation + + +## Table of Contents + +- [onos/p4rt/v1/pipeline_config.proto](#onos_p4rt_v1_pipeline_config-proto) + - [ConfigurationEvent](#onos-p4rt-v1-ConfigurationEvent) + - [Cookie](#onos-p4rt-v1-Cookie) + - [MastershipInfo](#onos-p4rt-v1-MastershipInfo) + - [PipelineConfig](#onos-p4rt-v1-PipelineConfig) + - [PipelineConfigSpec](#onos-p4rt-v1-PipelineConfigSpec) + - [PipelineConfigStatus](#onos-p4rt-v1-PipelineConfigStatus) + + - [ConfigurationAction](#onos-p4rt-v1-ConfigurationAction) + - [ConfigurationEvent.Type](#onos-p4rt-v1-ConfigurationEvent-Type) + - [PipelineConfigStatus.PipelineConfigState](#onos-p4rt-v1-PipelineConfigStatus-PipelineConfigState) + +- [Scalar Value Types](#scalar-value-types) + + + + + + +## onos/p4rt/v1/pipeline_config.proto + + + + + +### ConfigurationEvent +ConfigurationEvent configuration store event + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| type | [ConfigurationEvent.Type](#onos-p4rt-v1-ConfigurationEvent-Type) | | EventType configuration event type | +| pipeline_config | [PipelineConfig](#onos-p4rt-v1-PipelineConfig) | | | + + + + + + + + +### Cookie +Cookie + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| cookie | [uint64](#uint64) | | | + + + + + + + + +### MastershipInfo + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| master | [string](#string) | | | +| term | [uint64](#uint64) | | | + + + + + + + + +### PipelineConfig +PipelineConfig P4 device pipeline config + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| meta | [ObjectMeta](#onos-p4rt-v1-ObjectMeta) | | | +| id | [string](#string) | | 'id' is a unique configuration identifier | +| target_id | [string](#string) | | 'target_id' is the target to which the desired target configuration applies | +| cookie | [Cookie](#onos-p4rt-v1-Cookie) | | 'cookie' to uniquely identify a forwarding-pipeline configuration among others managed by the same control plane | +| status | [PipelineConfigStatus](#onos-p4rt-v1-PipelineConfigStatus) | | 'ConfigurationStatus' is the current lifecycle status of the configuration | +| action | [ConfigurationAction](#onos-p4rt-v1-ConfigurationAction) | | ConfigurationAction | +| spec | [PipelineConfigSpec](#onos-p4rt-v1-PipelineConfigSpec) | | PipelineConfigSpec device pipeline config spec | + + + + + + + + +### PipelineConfigSpec +PipelineConfigSpec device pipeline configuration spec + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| p4_device_config | [bytes](#bytes) | | 'p4_device_config' P4 device configuration bytes | +| p4_info | [bytes](#bytes) | | TODO since p4 info is target agnostic, we can import it from P4runtime and use it as it is, a new version of proto compiler image is needed 'p4_info' P4 info | + + + + + + + + +### PipelineConfigStatus +PipelineConfigStatus pipelineConfig status + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| state | [PipelineConfigStatus.PipelineConfigState](#onos-p4rt-v1-PipelineConfigStatus-PipelineConfigState) | | 'PipelineConfigState' pipeline config state | +| mastership | [MastershipInfo](#onos-p4rt-v1-MastershipInfo) | | 'mastership' is the current mastership info for the configuration | + + + + + + + + + + +### ConfigurationAction +ConfigurationAction + +| Name | Number | Description | +| ---- | ------ | ----------- | +| UNSPECIFIED | 0 | | +| VERIFY | 1 | Verifies that the target can realize the given config. The forwarding state in the target is not modified. | +| VERIFY_AND_SAVE | 2 | Saves the config if the P4Runtime target can realize it. The forwarding state in the target is not modified. | +| VERIFY_AND_COMMIT | 3 | Saves and realizes the given config if the P4Runtime target can realize it. The forwarding state in the target is cleared. | +| COMMIT | 4 | Realizes the last saved, but not yet committed, config. The forwarding state in the target is updated by replaying the write requests to the target device since the last config was saved | +| RECONCILE_AND_COMMIT | 5 | Verifies, saves and realizes the given config, while preserving the forwarding state in the target. | + + + + + +### ConfigurationEvent.Type +Type configuration event types for configuration store + +| Name | Number | Description | +| ---- | ------ | ----------- | +| UNKNOWN | 0 | UNKNOWN indicates unknown configuration store event | +| CREATED | 1 | CREATED indicates the configuration entry in the store is created | +| UPDATED | 2 | UPDATED indicates the configuration entry in the store is updated | +| DELETED | 3 | DELETED indicates the configuration entry in the store is deleted | +| REPLAYED | 4 | REPLAYED | + + + + + +### PipelineConfigStatus.PipelineConfigState + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| UNKNOWN | 0 | UNKNOWN indicates the pipeline configuration state is unknown | +| PENDING | 1 | PENDING indicates the pipeline configuration state is pending | +| COMPLETE | 2 | COMPLETE indicates the pipeline configuration state is complete | +| FAILED | 3 | FAILED indicates the pipeline configuration state failed | + + + + + + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | 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 | int32 | int | integer | Bignum or Fixnum (as required) | +| 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 | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/onos-api/docs/onos/pci/pci.md b/onos-api/docs/onos/pci/pci.md new file mode 100644 index 0000000..ffcc83a --- /dev/null +++ b/onos-api/docs/onos/pci/pci.md @@ -0,0 +1,254 @@ +# Protocol Documentation + + +## Table of Contents + +- [onos/pci/pci.proto](#onos_pci_pci-proto) + - [CellResolution](#onos-pci-CellResolution) + - [GetCellRequest](#onos-pci-GetCellRequest) + - [GetCellResponse](#onos-pci-GetCellResponse) + - [GetCellsRequest](#onos-pci-GetCellsRequest) + - [GetCellsResponse](#onos-pci-GetCellsResponse) + - [GetConflictsRequest](#onos-pci-GetConflictsRequest) + - [GetConflictsResponse](#onos-pci-GetConflictsResponse) + - [GetResolvedConflictsRequest](#onos-pci-GetResolvedConflictsRequest) + - [GetResolvedConflictsResponse](#onos-pci-GetResolvedConflictsResponse) + - [PciCell](#onos-pci-PciCell) + - [PciRange](#onos-pci-PciRange) + + - [CellType](#onos-pci-CellType) + + - [Pci](#onos-pci-Pci) + +- [Scalar Value Types](#scalar-value-types) + + + + + + +## onos/pci/pci.proto + + + + + +### CellResolution + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [uint64](#uint64) | | | +| resolved_pci | [uint32](#uint32) | | | +| original_pci | [uint32](#uint32) | | | +| resolved_conflicts | [uint32](#uint32) | | | + + + + + + + + +### GetCellRequest +cell id required + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| cell_id | [uint64](#uint64) | | | + + + + + + + + +### GetCellResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| cell | [PciCell](#onos-pci-PciCell) | | | + + + + + + + + +### GetCellsRequest + + + + + + + + + +### GetCellsResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| cells | [PciCell](#onos-pci-PciCell) | repeated | | + + + + + + + + +### GetConflictsRequest +if cell id is not specified, will return all cells with conflicts + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| cell_id | [uint64](#uint64) | | | + + + + + + + + +### GetConflictsResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| cells | [PciCell](#onos-pci-PciCell) | repeated | | + + + + + + + + +### GetResolvedConflictsRequest + + + + + + + + + +### GetResolvedConflictsResponse +returns all the resolved conflicts in the store + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| cells | [CellResolution](#onos-pci-CellResolution) | repeated | | + + + + + + + + +### PciCell + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [uint64](#uint64) | | | +| node_id | [string](#string) | | | +| arfcn | [uint32](#uint32) | | | +| cell_type | [CellType](#onos-pci-CellType) | | | +| pci | [uint32](#uint32) | | | +| pci_pool | [PciRange](#onos-pci-PciRange) | repeated | | +| neighbor_ids | [uint64](#uint64) | repeated | | + + + + + + + + +### PciRange + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| min | [uint32](#uint32) | | | +| max | [uint32](#uint32) | | | + + + + + + + + + + +### CellType + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| FEMTO | 0 | | +| ENTERPRISE | 1 | | +| OUTDOOR_SMALL | 2 | | +| MACRO | 3 | | + + + + + + + + + +### Pci + + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| GetConflicts | [GetConflictsRequest](#onos-pci-GetConflictsRequest) | [GetConflictsResponse](#onos-pci-GetConflictsResponse) | | +| GetResolvedConflicts | [GetResolvedConflictsRequest](#onos-pci-GetResolvedConflictsRequest) | [GetResolvedConflictsResponse](#onos-pci-GetResolvedConflictsResponse) | | +| GetCell | [GetCellRequest](#onos-pci-GetCellRequest) | [GetCellResponse](#onos-pci-GetCellResponse) | | +| GetCells | [GetCellsRequest](#onos-pci-GetCellsRequest) | [GetCellsResponse](#onos-pci-GetCellsResponse) | | + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | 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 | int32 | int | integer | Bignum or Fixnum (as required) | +| 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 | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/onos-api/docs/onos/provisioner/pipeline.md b/onos-api/docs/onos/provisioner/pipeline.md new file mode 100644 index 0000000..3069ec4 --- /dev/null +++ b/onos-api/docs/onos/provisioner/pipeline.md @@ -0,0 +1,380 @@ +# Protocol Documentation + + +## Table of Contents + +- [onos/provisioner/aspects.proto](#onos_provisioner_aspects-proto) + - [ChassisConfigState](#onos-provisioner-ChassisConfigState) + - [ConfigStatus](#onos-provisioner-ConfigStatus) + - [DeviceConfig](#onos-provisioner-DeviceConfig) + - [Failure](#onos-provisioner-Failure) + - [PipelineConfigState](#onos-provisioner-PipelineConfigState) + + - [ConfigStatus.State](#onos-provisioner-ConfigStatus-State) + - [Failure.Type](#onos-provisioner-Failure-Type) + +- [onos/provisioner/config.proto](#onos_provisioner_config-proto) + - [AddConfigRequest](#onos-provisioner-AddConfigRequest) + - [AddConfigResponse](#onos-provisioner-AddConfigResponse) + - [Config](#onos-provisioner-Config) + - [Config.ArtifactsEntry](#onos-provisioner-Config-ArtifactsEntry) + - [ConfigRecord](#onos-provisioner-ConfigRecord) + - [DeleteConfigRequest](#onos-provisioner-DeleteConfigRequest) + - [DeleteConfigResponse](#onos-provisioner-DeleteConfigResponse) + - [GetConfigRequest](#onos-provisioner-GetConfigRequest) + - [GetConfigResponse](#onos-provisioner-GetConfigResponse) + - [ListConfigsRequest](#onos-provisioner-ListConfigsRequest) + - [ListConfigsResponse](#onos-provisioner-ListConfigsResponse) + + - [ProvisionerService](#onos-provisioner-ProvisionerService) + +- [Scalar Value Types](#scalar-value-types) + + + + + + +## onos/provisioner/aspects.proto + + + + + +### ChassisConfigState +ChassisConfigState is a topology entity aspect used to indicate what chassis config a device has presently applied to it + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| config_id | [string](#string) | | | +| updated | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | | +| status | [ConfigStatus](#onos-provisioner-ConfigStatus) | | | + + + + + + + + +### ConfigStatus + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| state | [ConfigStatus.State](#onos-provisioner-ConfigStatus-State) | | 'state' config state | +| failure | [Failure](#onos-provisioner-Failure) | | 'failure' is the transaction failure (if any) | + + + + + + + + +### DeviceConfig +DeviceConfig is a topology entity aspect used to specify what pipeline and chassis config a device should have applied to it + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| pipeline_config_id | [string](#string) | | | +| chassis_config_id | [string](#string) | | | + + + + + + + + +### Failure +Failure config update failure type and description + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| type | [Failure.Type](#onos-provisioner-Failure-Type) | | | +| description | [string](#string) | | | + + + + + + + + +### PipelineConfigState +PipelineConfigState is a topology entity aspect used to indicate what pipeline config a device has presently applied to it + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| config_id | [string](#string) | | | +| cookie | [uint64](#uint64) | | | +| updated | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | | +| status | [ConfigStatus](#onos-provisioner-ConfigStatus) | | | + + + + + + + + + + +### ConfigStatus.State + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| PENDING | 0 | | +| APPLIED | 3 | | +| FAILED | 4 | | + + + + + +### Failure.Type + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| UNKNOWN | 0 | UNKNOWN unknown failure | +| CANCELED | 1 | CANCELED | +| NOT_FOUND | 2 | NOT_FOUND | +| ALREADY_EXISTS | 3 | ALREADY_EXISTS | +| UNAUTHORIZED | 4 | UNAUTHORIZED | +| FORBIDDEN | 5 | FORBIDDEN | +| CONFLICT | 6 | CONFLICT | +| INVALID | 7 | INVALID | +| UNAVAILABLE | 8 | UNAVAILABLE | +| NOT_SUPPORTED | 9 | NOT_SUPPORTED | +| TIMEOUT | 10 | TIMEOUT | +| INTERNAL | 11 | INTERNAL | + + + + + + + + + + + + + +## onos/provisioner/config.proto + + + + + +### AddConfigRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| config | [Config](#onos-provisioner-Config) | | | + + + + + + + + +### AddConfigResponse + + + + + + + + + +### Config +Config represents + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| record | [ConfigRecord](#onos-provisioner-ConfigRecord) | | | +| artifacts | [Config.ArtifactsEntry](#onos-provisioner-Config-ArtifactsEntry) | repeated | | + + + + + + + + +### Config.ArtifactsEntry + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [bytes](#bytes) | | | + + + + + + + + +### ConfigRecord +ConfigRecord is used for storing a record of the pipeline or chassis configuration with +references to its related file artifact(s) + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| config_id | [string](#string) | | | +| kind | [string](#string) | | pipeline, chassis, etc. | +| artifacts | [string](#string) | repeated | list of associated artifact types | + + + + + + + + +### DeleteConfigRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| config_id | [string](#string) | | | + + + + + + + + +### DeleteConfigResponse + + + + + + + + + +### GetConfigRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| config_id | [string](#string) | | | +| include_artifacts | [bool](#bool) | | | + + + + + + + + +### GetConfigResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| config | [Config](#onos-provisioner-Config) | | | + + + + + + + + +### ListConfigsRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| kind | [string](#string) | | | +| include_artifacts | [bool](#bool) | | | +| watch | [bool](#bool) | | | + + + + + + + + +### ListConfigsResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| config | [Config](#onos-provisioner-Config) | | | + + + + + + + + + + + + + + +### ProvisionerService +ProvisionerService allows managing inventory of various device configuratoins, e.g., pipeline, chassis. + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| Add | [AddConfigRequest](#onos-provisioner-AddConfigRequest) | [AddConfigResponse](#onos-provisioner-AddConfigResponse) | Add registers new pipeline configuration | +| Delete | [DeleteConfigRequest](#onos-provisioner-DeleteConfigRequest) | [DeleteConfigResponse](#onos-provisioner-DeleteConfigResponse) | Delete removes a pipeline configuration | +| Get | [GetConfigRequest](#onos-provisioner-GetConfigRequest) | [GetConfigResponse](#onos-provisioner-GetConfigResponse) | Get returns pipeline configuration based on a given ID | +| List | [ListConfigsRequest](#onos-provisioner-ListConfigsRequest) | [ListConfigsResponse](#onos-provisioner-ListConfigsResponse) stream | List returns all registered pipelines | + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | 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 | int32 | int | integer | Bignum or Fixnum (as required) | +| 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 | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/onos-api/docs/onos/ransim/metrics.md b/onos-api/docs/onos/ransim/metrics.md new file mode 100644 index 0000000..05d5319 --- /dev/null +++ b/onos-api/docs/onos/ransim/metrics.md @@ -0,0 +1,274 @@ +# Protocol Documentation + + +## Table of Contents + +- [onos/ransim/metrics/metrics.proto](#onos_ransim_metrics_metrics-proto) + - [DeleteAllRequest](#onos-ransim-metrics-DeleteAllRequest) + - [DeleteAllResponse](#onos-ransim-metrics-DeleteAllResponse) + - [DeleteRequest](#onos-ransim-metrics-DeleteRequest) + - [DeleteResponse](#onos-ransim-metrics-DeleteResponse) + - [GetRequest](#onos-ransim-metrics-GetRequest) + - [GetResponse](#onos-ransim-metrics-GetResponse) + - [ListRequest](#onos-ransim-metrics-ListRequest) + - [ListResponse](#onos-ransim-metrics-ListResponse) + - [Metric](#onos-ransim-metrics-Metric) + - [SetRequest](#onos-ransim-metrics-SetRequest) + - [SetResponse](#onos-ransim-metrics-SetResponse) + - [WatchRequest](#onos-ransim-metrics-WatchRequest) + - [WatchResponse](#onos-ransim-metrics-WatchResponse) + + - [EventType](#onos-ransim-metrics-EventType) + + - [MetricsService](#onos-ransim-metrics-MetricsService) + +- [Scalar Value Types](#scalar-value-types) + + + + + + +## onos/ransim/metrics/metrics.proto + + + + + +### DeleteAllRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| entityid | [uint64](#uint64) | | | + + + + + + + + +### DeleteAllResponse + + + + + + + + + +### DeleteRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| entityid | [uint64](#uint64) | | | +| name | [string](#string) | | | + + + + + + + + +### DeleteResponse + + + + + + + + + +### GetRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| entityid | [uint64](#uint64) | | | +| name | [string](#string) | | | + + + + + + + + +### GetResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| metric | [Metric](#onos-ransim-metrics-Metric) | | | + + + + + + + + +### ListRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| entityid | [uint64](#uint64) | | | + + + + + + + + +### ListResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| entityid | [uint64](#uint64) | | | +| metrics | [Metric](#onos-ransim-metrics-Metric) | repeated | | + + + + + + + + +### Metric + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| entityid | [uint64](#uint64) | | | +| key | [string](#string) | | | +| value | [string](#string) | | | +| type | [string](#string) | | intX, uintX, floatX, string; X := {8|16|32|64} | + + + + + + + + +### SetRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| metric | [Metric](#onos-ransim-metrics-Metric) | | | + + + + + + + + +### SetResponse + + + + + + + + + +### WatchRequest + + + + + + + + + +### WatchResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| metric | [Metric](#onos-ransim-metrics-Metric) | | | +| type | [EventType](#onos-ransim-metrics-EventType) | | | + + + + + + + + + + +### EventType +Change event type + +| Name | Number | Description | +| ---- | ------ | ----------- | +| NONE | 0 | NONE indicates unknown event type | +| UPDATED | 1 | UPDATED indicates a metric value was set (updated) | +| DELETED | 2 | DELETED indicates a metric was deleted | + + + + + + + + + +### MetricsService +Model provides means to create, delete and read RAN simulation model. + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| List | [ListRequest](#onos-ransim-metrics-ListRequest) | [ListResponse](#onos-ransim-metrics-ListResponse) | List returns an array of all metrics for the specified entity (Node, Cell or UE) | +| Set | [SetRequest](#onos-ransim-metrics-SetRequest) | [SetResponse](#onos-ransim-metrics-SetResponse) | Set sets value of the named metric for the specified entity | +| Get | [GetRequest](#onos-ransim-metrics-GetRequest) | [GetResponse](#onos-ransim-metrics-GetResponse) | Get retrieves the named metric for the specified entity | +| Delete | [DeleteRequest](#onos-ransim-metrics-DeleteRequest) | [DeleteResponse](#onos-ransim-metrics-DeleteResponse) | Delete deletes the the named metric for the specified entity | +| DeleteAll | [DeleteAllRequest](#onos-ransim-metrics-DeleteAllRequest) | [DeleteAllResponse](#onos-ransim-metrics-DeleteAllResponse) | DeleteAll deletes all metrics for the specified entity | +| Watch | [WatchRequest](#onos-ransim-metrics-WatchRequest) | [WatchResponse](#onos-ransim-metrics-WatchResponse) stream | Watch returns a stream of ongoing changes to the metrics | + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | 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 | int32 | int | integer | Bignum or Fixnum (as required) | +| 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 | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/onos-api/docs/onos/ransim/model.md b/onos-api/docs/onos/ransim/model.md new file mode 100644 index 0000000..ec8d187 --- /dev/null +++ b/onos-api/docs/onos/ransim/model.md @@ -0,0 +1,1002 @@ +# Protocol Documentation + + +## Table of Contents + +- [onos/ransim/model/model.proto](#onos_ransim_model_model-proto) + - [AgentControlRequest](#onos-ransim-model-AgentControlRequest) + - [AgentControlResponse](#onos-ransim-model-AgentControlResponse) + - [ClearRequest](#onos-ransim-model-ClearRequest) + - [ClearResponse](#onos-ransim-model-ClearResponse) + - [CreateCellRequest](#onos-ransim-model-CreateCellRequest) + - [CreateCellResponse](#onos-ransim-model-CreateCellResponse) + - [CreateNodeRequest](#onos-ransim-model-CreateNodeRequest) + - [CreateNodeResponse](#onos-ransim-model-CreateNodeResponse) + - [CreateRouteRequest](#onos-ransim-model-CreateRouteRequest) + - [CreateRouteResponse](#onos-ransim-model-CreateRouteResponse) + - [DataSet](#onos-ransim-model-DataSet) + - [DeleteCellRequest](#onos-ransim-model-DeleteCellRequest) + - [DeleteCellResponse](#onos-ransim-model-DeleteCellResponse) + - [DeleteNodeRequest](#onos-ransim-model-DeleteNodeRequest) + - [DeleteNodeResponse](#onos-ransim-model-DeleteNodeResponse) + - [DeleteRouteRequest](#onos-ransim-model-DeleteRouteRequest) + - [DeleteRouteResponse](#onos-ransim-model-DeleteRouteResponse) + - [DeleteUERequest](#onos-ransim-model-DeleteUERequest) + - [DeleteUEResponse](#onos-ransim-model-DeleteUEResponse) + - [GetCellRequest](#onos-ransim-model-GetCellRequest) + - [GetCellResponse](#onos-ransim-model-GetCellResponse) + - [GetNodeRequest](#onos-ransim-model-GetNodeRequest) + - [GetNodeResponse](#onos-ransim-model-GetNodeResponse) + - [GetRouteRequest](#onos-ransim-model-GetRouteRequest) + - [GetRouteResponse](#onos-ransim-model-GetRouteResponse) + - [GetUECountRequest](#onos-ransim-model-GetUECountRequest) + - [GetUECountResponse](#onos-ransim-model-GetUECountResponse) + - [GetUERequest](#onos-ransim-model-GetUERequest) + - [GetUEResponse](#onos-ransim-model-GetUEResponse) + - [ListCellsRequest](#onos-ransim-model-ListCellsRequest) + - [ListCellsResponse](#onos-ransim-model-ListCellsResponse) + - [ListNodesRequest](#onos-ransim-model-ListNodesRequest) + - [ListNodesResponse](#onos-ransim-model-ListNodesResponse) + - [ListRoutesRequest](#onos-ransim-model-ListRoutesRequest) + - [ListRoutesResponse](#onos-ransim-model-ListRoutesResponse) + - [ListUEsRequest](#onos-ransim-model-ListUEsRequest) + - [ListUEsResponse](#onos-ransim-model-ListUEsResponse) + - [LoadRequest](#onos-ransim-model-LoadRequest) + - [LoadResponse](#onos-ransim-model-LoadResponse) + - [MoveToCellRequest](#onos-ransim-model-MoveToCellRequest) + - [MoveToCellResponse](#onos-ransim-model-MoveToCellResponse) + - [MoveToLocationRequest](#onos-ransim-model-MoveToLocationRequest) + - [MoveToLocationResponse](#onos-ransim-model-MoveToLocationResponse) + - [PlmnIDRequest](#onos-ransim-model-PlmnIDRequest) + - [PlmnIDResponse](#onos-ransim-model-PlmnIDResponse) + - [SetUECountRequest](#onos-ransim-model-SetUECountRequest) + - [SetUECountResponse](#onos-ransim-model-SetUECountResponse) + - [UpdateCellRequest](#onos-ransim-model-UpdateCellRequest) + - [UpdateCellResponse](#onos-ransim-model-UpdateCellResponse) + - [UpdateNodeRequest](#onos-ransim-model-UpdateNodeRequest) + - [UpdateNodeResponse](#onos-ransim-model-UpdateNodeResponse) + - [WatchCellsRequest](#onos-ransim-model-WatchCellsRequest) + - [WatchCellsResponse](#onos-ransim-model-WatchCellsResponse) + - [WatchNodesRequest](#onos-ransim-model-WatchNodesRequest) + - [WatchNodesResponse](#onos-ransim-model-WatchNodesResponse) + - [WatchRoutesRequest](#onos-ransim-model-WatchRoutesRequest) + - [WatchRoutesResponse](#onos-ransim-model-WatchRoutesResponse) + - [WatchUEsRequest](#onos-ransim-model-WatchUEsRequest) + - [WatchUEsResponse](#onos-ransim-model-WatchUEsResponse) + + - [EventType](#onos-ransim-model-EventType) + + - [CellModel](#onos-ransim-model-CellModel) + - [ModelService](#onos-ransim-model-ModelService) + - [NodeModel](#onos-ransim-model-NodeModel) + - [RouteModel](#onos-ransim-model-RouteModel) + - [UEModel](#onos-ransim-model-UEModel) + +- [Scalar Value Types](#scalar-value-types) + + + + + + +## onos/ransim/model/model.proto + + + + + +### AgentControlRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| enbid | [uint64](#uint64) | | | +| command | [string](#string) | | start, stop, drop, reconnect, etc. | +| args | [string](#string) | repeated | optional command parameters | + + + + + + + + +### AgentControlResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| node | [onos.ransim.types.Node](#onos-ransim-types-Node) | | | + + + + + + + + +### ClearRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| resume | [bool](#bool) | | | + + + + + + + + +### ClearResponse + + + + + + + + + +### CreateCellRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| cell | [onos.ransim.types.Cell](#onos-ransim-types-Cell) | | | + + + + + + + + +### CreateCellResponse + + + + + + + + + +### CreateNodeRequest +CreateNodeRequest create a node request + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| node | [onos.ransim.types.Node](#onos-ransim-types-Node) | | | + + + + + + + + +### CreateNodeResponse +CreateNodeResponse create a node response + + + + + + + + +### CreateRouteRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| route | [onos.ransim.types.Route](#onos-ransim-types-Route) | | | + + + + + + + + +### CreateRouteResponse + + + + + + + + + +### DataSet + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| type | [string](#string) | | | +| data | [bytes](#bytes) | | | + + + + + + + + +### DeleteCellRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| enbid | [uint64](#uint64) | | | + + + + + + + + +### DeleteCellResponse + + + + + + + + + +### DeleteNodeRequest +DeleteNodeRequest delete a node request + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| enbid | [uint64](#uint64) | | | + + + + + + + + +### DeleteNodeResponse +DeleteNodeResponse delete a node response + + + + + + + + +### DeleteRouteRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| enbid | [uint64](#uint64) | | | + + + + + + + + +### DeleteRouteResponse + + + + + + + + + +### DeleteUERequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| imsi | [uint32](#uint32) | | | + + + + + + + + +### DeleteUEResponse + + + + + + + + + +### GetCellRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| ecgi | [uint64](#uint64) | | | + + + + + + + + +### GetCellResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| cell | [onos.ransim.types.Cell](#onos-ransim-types-Cell) | | | + + + + + + + + +### GetNodeRequest +GetNodeRequest get a node request + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| enbid | [uint64](#uint64) | | | + + + + + + + + +### GetNodeResponse +GetNodeResponse get a node response + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| node | [onos.ransim.types.Node](#onos-ransim-types-Node) | | | + + + + + + + + +### GetRouteRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| imsi | [uint32](#uint32) | | | + + + + + + + + +### GetRouteResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| route | [onos.ransim.types.Route](#onos-ransim-types-Route) | | | + + + + + + + + +### GetUECountRequest + + + + + + + + + +### GetUECountResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| count | [uint32](#uint32) | | | + + + + + + + + +### GetUERequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| imsi | [uint32](#uint32) | | | + + + + + + + + +### GetUEResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| ue | [onos.ransim.types.Ue](#onos-ransim-types-Ue) | | | + + + + + + + + +### ListCellsRequest + + + + + + + + + +### ListCellsResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| Cell | [onos.ransim.types.Cell](#onos-ransim-types-Cell) | | | + + + + + + + + +### ListNodesRequest + + + + + + + + + +### ListNodesResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| node | [onos.ransim.types.Node](#onos-ransim-types-Node) | | | + + + + + + + + +### ListRoutesRequest + + + + + + + + + +### ListRoutesResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| route | [onos.ransim.types.Route](#onos-ransim-types-Route) | | | + + + + + + + + +### ListUEsRequest + + + + + + + + + +### ListUEsResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| ue | [onos.ransim.types.Ue](#onos-ransim-types-Ue) | | | + + + + + + + + +### LoadRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| dataSet | [DataSet](#onos-ransim-model-DataSet) | repeated | | +| resume | [bool](#bool) | | | + + + + + + + + +### LoadResponse + + + + + + + + + +### MoveToCellRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| imsi | [uint32](#uint32) | | | +| ecgi | [uint32](#uint32) | | | + + + + + + + + +### MoveToCellResponse + + + + + + + + + +### MoveToLocationRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| imsi | [uint32](#uint32) | | | +| location | [onos.ransim.types.Point](#onos-ransim-types-Point) | | | +| heading | [uint32](#uint32) | | | + + + + + + + + +### MoveToLocationResponse + + + + + + + + + +### PlmnIDRequest + + + + + + + + + +### PlmnIDResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| plmnid | [uint32](#uint32) | | | + + + + + + + + +### SetUECountRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| count | [uint32](#uint32) | | | + + + + + + + + +### SetUECountResponse + + + + + + + + + +### UpdateCellRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| cell | [onos.ransim.types.Cell](#onos-ransim-types-Cell) | | | + + + + + + + + +### UpdateCellResponse + + + + + + + + + +### UpdateNodeRequest +UpdateNodeRequest update a node request + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| node | [onos.ransim.types.Node](#onos-ransim-types-Node) | | | + + + + + + + + +### UpdateNodeResponse +UpdateNodeResponse update a node response + + + + + + + + +### WatchCellsRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| no_replay | [bool](#bool) | | | +| no_subscribe | [bool](#bool) | | | + + + + + + + + +### WatchCellsResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| cell | [onos.ransim.types.Cell](#onos-ransim-types-Cell) | | | +| type | [EventType](#onos-ransim-model-EventType) | | | + + + + + + + + +### WatchNodesRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| no_replay | [bool](#bool) | | | +| no_subscribe | [bool](#bool) | | | + + + + + + + + +### WatchNodesResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| node | [onos.ransim.types.Node](#onos-ransim-types-Node) | | | +| type | [EventType](#onos-ransim-model-EventType) | | | + + + + + + + + +### WatchRoutesRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| no_replay | [bool](#bool) | | | +| no_subscribe | [bool](#bool) | | | + + + + + + + + +### WatchRoutesResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| route | [onos.ransim.types.Route](#onos-ransim-types-Route) | | | +| type | [EventType](#onos-ransim-model-EventType) | | | + + + + + + + + +### WatchUEsRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| no_replay | [bool](#bool) | | | +| no_subscribe | [bool](#bool) | | | + + + + + + + + +### WatchUEsResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| ue | [onos.ransim.types.Ue](#onos-ransim-types-Ue) | | | +| type | [EventType](#onos-ransim-model-EventType) | | | + + + + + + + + + + +### EventType +Change event type + +| Name | Number | Description | +| ---- | ------ | ----------- | +| NONE | 0 | NONE indicates this response represents a pre-existing entity | +| CREATED | 1 | CREATED indicates a new entity was created | +| UPDATED | 2 | UPDATED indicates an existing entity was updated | +| DELETED | 3 | DELETED indicates an entity was deleted | + + + + + + + + + +### CellModel +CellModel provides means to create, delete and read simulated RAN cells. + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| CreateCell | [CreateCellRequest](#onos-ransim-model-CreateCellRequest) | [CreateCellResponse](#onos-ransim-model-CreateCellResponse) | | +| DeleteCell | [DeleteCellRequest](#onos-ransim-model-DeleteCellRequest) | [DeleteCellResponse](#onos-ransim-model-DeleteCellResponse) | | +| UpdateCell | [UpdateCellRequest](#onos-ransim-model-UpdateCellRequest) | [UpdateCellResponse](#onos-ransim-model-UpdateCellResponse) | | +| GetCell | [GetCellRequest](#onos-ransim-model-GetCellRequest) | [GetCellResponse](#onos-ransim-model-GetCellResponse) | | +| WatchCells | [WatchCellsRequest](#onos-ransim-model-WatchCellsRequest) | [WatchCellsResponse](#onos-ransim-model-WatchCellsResponse) stream | | +| ListCells | [ListCellsRequest](#onos-ransim-model-ListCellsRequest) | [ListCellsResponse](#onos-ransim-model-ListCellsResponse) stream | | + + + + +### ModelService +ModelService provides means to clear and load node and cell model in bulk + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| Load | [LoadRequest](#onos-ransim-model-LoadRequest) | [LoadResponse](#onos-ransim-model-LoadResponse) | | +| Clear | [ClearRequest](#onos-ransim-model-ClearRequest) | [ClearResponse](#onos-ransim-model-ClearResponse) | | + + + + +### NodeModel +NodeModel provides means to create, delete and read simulated RAN nodes. + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| GetPlmnID | [PlmnIDRequest](#onos-ransim-model-PlmnIDRequest) | [PlmnIDResponse](#onos-ransim-model-PlmnIDResponse) | | +| CreateNode | [CreateNodeRequest](#onos-ransim-model-CreateNodeRequest) | [CreateNodeResponse](#onos-ransim-model-CreateNodeResponse) | | +| GetNode | [GetNodeRequest](#onos-ransim-model-GetNodeRequest) | [GetNodeResponse](#onos-ransim-model-GetNodeResponse) | | +| UpdateNode | [UpdateNodeRequest](#onos-ransim-model-UpdateNodeRequest) | [UpdateNodeResponse](#onos-ransim-model-UpdateNodeResponse) | | +| DeleteNode | [DeleteNodeRequest](#onos-ransim-model-DeleteNodeRequest) | [DeleteNodeResponse](#onos-ransim-model-DeleteNodeResponse) | | +| WatchNodes | [WatchNodesRequest](#onos-ransim-model-WatchNodesRequest) | [WatchNodesResponse](#onos-ransim-model-WatchNodesResponse) stream | | +| ListNodes | [ListNodesRequest](#onos-ransim-model-ListNodesRequest) | [ListNodesResponse](#onos-ransim-model-ListNodesResponse) stream | | +| AgentControl | [AgentControlRequest](#onos-ransim-model-AgentControlRequest) | [AgentControlResponse](#onos-ransim-model-AgentControlResponse) | | + + + + +### RouteModel +RouteModel provides means to create, delete and read simulated mobile UE routes. + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| CreateRoute | [CreateRouteRequest](#onos-ransim-model-CreateRouteRequest) | [CreateRouteResponse](#onos-ransim-model-CreateRouteResponse) | | +| DeleteRoute | [DeleteRouteRequest](#onos-ransim-model-DeleteRouteRequest) | [DeleteRouteResponse](#onos-ransim-model-DeleteRouteResponse) | | +| GetRoute | [GetRouteRequest](#onos-ransim-model-GetRouteRequest) | [GetRouteResponse](#onos-ransim-model-GetRouteResponse) | | +| WatchRoutes | [WatchRoutesRequest](#onos-ransim-model-WatchRoutesRequest) | [WatchRoutesResponse](#onos-ransim-model-WatchRoutesResponse) stream | | +| ListRoutes | [ListRoutesRequest](#onos-ransim-model-ListRoutesRequest) | [ListRoutesResponse](#onos-ransim-model-ListRoutesResponse) stream | | + + + + +### UEModel +UEModel provides means to simulate mobile UEs. + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| GetUE | [GetUERequest](#onos-ransim-model-GetUERequest) | [GetUEResponse](#onos-ransim-model-GetUEResponse) | | +| MoveToCell | [MoveToCellRequest](#onos-ransim-model-MoveToCellRequest) | [MoveToCellResponse](#onos-ransim-model-MoveToCellResponse) | | +| MoveToLocation | [MoveToLocationRequest](#onos-ransim-model-MoveToLocationRequest) | [MoveToLocationResponse](#onos-ransim-model-MoveToLocationResponse) | | +| DeleteUE | [DeleteUERequest](#onos-ransim-model-DeleteUERequest) | [DeleteUEResponse](#onos-ransim-model-DeleteUEResponse) | | +| WatchUEs | [WatchUEsRequest](#onos-ransim-model-WatchUEsRequest) | [WatchUEsResponse](#onos-ransim-model-WatchUEsResponse) stream | | +| ListUEs | [ListUEsRequest](#onos-ransim-model-ListUEsRequest) | [ListUEsResponse](#onos-ransim-model-ListUEsResponse) stream | | +| GetUECount | [GetUECountRequest](#onos-ransim-model-GetUECountRequest) | [GetUECountResponse](#onos-ransim-model-GetUECountResponse) | | +| SetUECount | [SetUECountRequest](#onos-ransim-model-SetUECountRequest) | [SetUECountResponse](#onos-ransim-model-SetUECountResponse) | | + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | 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 | int32 | int | integer | Bignum or Fixnum (as required) | +| 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 | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/onos-api/docs/onos/ransim/trafficsim.md b/onos-api/docs/onos/ransim/trafficsim.md new file mode 100644 index 0000000..d952ac6 --- /dev/null +++ b/onos-api/docs/onos/ransim/trafficsim.md @@ -0,0 +1,245 @@ +# Protocol Documentation + + +## Table of Contents + +- [onos/ransim/trafficsim/trafficsim.proto](#onos_ransim_trafficsim_trafficsim-proto) + - [ListRoutesRequest](#onos-ransim-trafficsim-ListRoutesRequest) + - [ListRoutesResponse](#onos-ransim-trafficsim-ListRoutesResponse) + - [ListUesRequest](#onos-ransim-trafficsim-ListUesRequest) + - [ListUesResponse](#onos-ransim-trafficsim-ListUesResponse) + - [MapLayoutRequest](#onos-ransim-trafficsim-MapLayoutRequest) + - [ResetMetricsMsg](#onos-ransim-trafficsim-ResetMetricsMsg) + - [SetNumberUEsRequest](#onos-ransim-trafficsim-SetNumberUEsRequest) + - [SetNumberUEsResponse](#onos-ransim-trafficsim-SetNumberUEsResponse) + - [WatchUesRequest](#onos-ransim-trafficsim-WatchUesRequest) + - [WatchUesResponse](#onos-ransim-trafficsim-WatchUesResponse) + + - [Type](#onos-ransim-trafficsim-Type) + - [UpdateType](#onos-ransim-trafficsim-UpdateType) + + - [Traffic](#onos-ransim-trafficsim-Traffic) + +- [Scalar Value Types](#scalar-value-types) + + + + + + +## onos/ransim/trafficsim/trafficsim.proto + + + + + +### ListRoutesRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| no_replay | [bool](#bool) | | | +| no_subscribe | [bool](#bool) | | | + + + + + + + + +### ListRoutesResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| route | [onos.ransim.types.Route](#onos-ransim-types-Route) | | route is the route change on which the event occurred | +| type | [Type](#onos-ransim-trafficsim-Type) | | type is a qualification of the type of change being made | + + + + + + + + +### ListUesRequest + + + + + + + + + +### ListUesResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| ue | [onos.ransim.types.Ue](#onos-ransim-types-Ue) | | Ue is the UserEquipment change on which the event occurred | + + + + + + + + +### MapLayoutRequest + + + + + + + + + +### ResetMetricsMsg + + + + + + + + + +### SetNumberUEsRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| number | [uint32](#uint32) | | | + + + + + + + + +### SetNumberUEsResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| number | [uint32](#uint32) | | | + + + + + + + + +### WatchUesRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| no_replay | [bool](#bool) | | | +| no_subscribe | [bool](#bool) | | | + + + + + + + + +### WatchUesResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| ue | [onos.ransim.types.Ue](#onos-ransim-types-Ue) | | Ue is the UserEquipment change on which the event occurred | +| type | [Type](#onos-ransim-trafficsim-Type) | | type is a qualification of the type of change being made | +| update_type | [UpdateType](#onos-ransim-trafficsim-UpdateType) | | update_type is a qualification of the type of UE change | + + + + + + + + + + +### Type +Change 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 | + + + + + +### UpdateType +In the case of an update this helps qualify the update type - add items as necessary + +| Name | Number | Description | +| ---- | ------ | ----------- | +| NOUPDATETYPE | 0 | | +| POSITION | 1 | POSITION An update in position of UE only, without a change in the Tower affinity | +| TOWER | 2 | TOWER An update in non-serving tower affinity (and also position) of UE | +| HANDOVER | 3 | HANDOVER An update of the serving tower | + + + + + + + + + +### Traffic +Traffic - provides a stream of traffic data to GUI + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| GetMapLayout | [MapLayoutRequest](#onos-ransim-trafficsim-MapLayoutRequest) | [.onos.ransim.types.MapLayout](#onos-ransim-types-MapLayout) | | +| ListRoutes | [ListRoutesRequest](#onos-ransim-trafficsim-ListRoutesRequest) | [ListRoutesResponse](#onos-ransim-trafficsim-ListRoutesResponse) stream | | +| ListUes | [ListUesRequest](#onos-ransim-trafficsim-ListUesRequest) | [ListUesResponse](#onos-ransim-trafficsim-ListUesResponse) stream | | +| WatchUes | [WatchUesRequest](#onos-ransim-trafficsim-WatchUesRequest) | [WatchUesResponse](#onos-ransim-trafficsim-WatchUesResponse) stream | | +| SetNumberUEs | [SetNumberUEsRequest](#onos-ransim-trafficsim-SetNumberUEsRequest) | [SetNumberUEsResponse](#onos-ransim-trafficsim-SetNumberUEsResponse) | | +| ResetMetrics | [ResetMetricsMsg](#onos-ransim-trafficsim-ResetMetricsMsg) | [ResetMetricsMsg](#onos-ransim-trafficsim-ResetMetricsMsg) | | + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | 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 | int32 | int | integer | Bignum or Fixnum (as required) | +| 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 | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/onos-api/docs/onos/ransim/types.md b/onos-api/docs/onos/ransim/types.md new file mode 100644 index 0000000..9d2ca02 --- /dev/null +++ b/onos-api/docs/onos/ransim/types.md @@ -0,0 +1,356 @@ +# Protocol Documentation + + +## Table of Contents + +- [onos/ransim/types/types.proto](#onos_ransim_types_types-proto) + - [Cell](#onos-ransim-types-Cell) + - [Cell.CrntiMapEntry](#onos-ransim-types-Cell-CrntiMapEntry) + - [EventA3Params](#onos-ransim-types-EventA3Params) + - [Guami](#onos-ransim-types-Guami) + - [MapLayout](#onos-ransim-types-MapLayout) + - [MeasurementParams](#onos-ransim-types-MeasurementParams) + - [MeasurementParams.NcellIndividualOffsetsEntry](#onos-ransim-types-MeasurementParams-NcellIndividualOffsetsEntry) + - [Node](#onos-ransim-types-Node) + - [Point](#onos-ransim-types-Point) + - [Route](#onos-ransim-types-Route) + - [Sector](#onos-ransim-types-Sector) + - [Ue](#onos-ransim-types-Ue) + - [UeIdentity](#onos-ransim-types-UeIdentity) + - [UeMetrics](#onos-ransim-types-UeMetrics) + + - [CellType](#onos-ransim-types-CellType) + +- [Scalar Value Types](#scalar-value-types) + + + + + + +## onos/ransim/types/types.proto + + + + + +### Cell + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| ecgi | [uint64](#uint64) | | | +| location | [Point](#onos-ransim-types-Point) | | | +| sector | [Sector](#onos-ransim-types-Sector) | | | +| color | [string](#string) | | | +| max_ues | [uint32](#uint32) | | | +| neighbors | [uint64](#uint64) | repeated | | +| tx_power_db | [double](#double) | | The cell transmit power in decibels | +| measurement_params | [MeasurementParams](#onos-ransim-types-MeasurementParams) | | | +| crnti_map | [Cell.CrntiMapEntry](#onos-ransim-types-Cell-CrntiMapEntry) | repeated | crntis maps a ue's name to its crnti | +| crnti_index | [uint32](#uint32) | | | +| port | [uint32](#uint32) | | | +| pci | [uint32](#uint32) | | | +| earfcn | [uint32](#uint32) | | | +| cell_type | [CellType](#onos-ransim-types-CellType) | | | +| rrc_idle_count | [uint32](#uint32) | | | +| rrc_connected_count | [uint32](#uint32) | | | + + + + + + + + +### Cell.CrntiMapEntry + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [uint32](#uint32) | | | +| value | [uint64](#uint64) | | | + + + + + + + + +### EventA3Params + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| a3_offset | [int32](#int32) | | | +| report_on_leave | [bool](#bool) | | | + + + + + + + + +### Guami + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| plmnid | [uint32](#uint32) | | 24 bits (12 bits for MCC and 12 bits for MNC) | +| amf_region_id | [uint32](#uint32) | | 8 bits | +| amf_set_id | [uint32](#uint32) | | 10 bits | +| amf_pointer | [uint32](#uint32) | | 6 bits | + + + + + + + + +### MapLayout + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| center | [Point](#onos-ransim-types-Point) | | Map center latitude and longitude | +| zoom | [float](#float) | | The starting Zoom level | +| fade | [bool](#bool) | | Show map as faded on start | +| show_routes | [bool](#bool) | | Show routes on start | +| show_power | [bool](#bool) | | Show power as circle on start | +| locations_scale | [float](#float) | | Ratio of random locations diameter to tower grid width | +| min_ues | [uint32](#uint32) | | FIXME: These are deprecated; remove Max number of UEs for complete simulation | +| max_ues | [uint32](#uint32) | | Max number of UEs for complete simulation | +| current_routes | [uint32](#uint32) | | the current number of routes | + + + + + + + + +### MeasurementParams + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| time_to_trigger | [int32](#int32) | | | +| frequency_offset | [int32](#int32) | | | +| pcell_individual_offset | [int32](#int32) | | | +| ncell_individual_offsets | [MeasurementParams.NcellIndividualOffsetsEntry](#onos-ransim-types-MeasurementParams-NcellIndividualOffsetsEntry) | repeated | | +| hysteresis | [int32](#int32) | | | +| event_a3_params | [EventA3Params](#onos-ransim-types-EventA3Params) | | | + + + + + + + + +### MeasurementParams.NcellIndividualOffsetsEntry + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [uint64](#uint64) | | | +| value | [int32](#int32) | | | + + + + + + + + +### Node + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| enbid | [uint32](#uint32) | | | +| controllers | [string](#string) | repeated | | +| service_models | [string](#string) | repeated | | +| cell_ecgis | [uint64](#uint64) | repeated | | +| status | [string](#string) | | | + + + + + + + + +### Point + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| lat | [double](#double) | | | +| lng | [double](#double) | | | + + + + + + + + +### Route + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [uint64](#uint64) | | | +| waypoints | [Point](#onos-ransim-types-Point) | repeated | | +| color | [string](#string) | | | +| speed_avg | [uint32](#uint32) | | | +| speed_stdev | [uint32](#uint32) | | | +| reverse | [bool](#bool) | | | +| next_point | [uint32](#uint32) | | | + + + + + + + + +### Sector + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| azimuth | [int32](#int32) | | | +| arc | [int32](#int32) | | | +| centroid | [Point](#onos-ransim-types-Point) | | | +| height | [int32](#int32) | | | +| tilt | [int32](#int32) | | | + + + + + + + + +### Ue + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| imsi | [uint64](#uint64) | | | +| type | [string](#string) | | | +| position | [Point](#onos-ransim-types-Point) | | | +| rotation | [uint32](#uint32) | | | +| serving_tower | [uint64](#uint64) | | | +| serving_tower_strength | [double](#double) | | | +| tower1 | [uint64](#uint64) | | | +| tower1_strength | [double](#double) | | | +| tower2 | [uint64](#uint64) | | | +| tower2_strength | [double](#double) | | | +| tower3 | [uint64](#uint64) | | | +| tower3_strength | [double](#double) | | | +| crnti | [uint32](#uint32) | | | +| admitted | [bool](#bool) | | | +| metrics | [UeMetrics](#onos-ransim-types-UeMetrics) | | | +| rrc_state | [uint32](#uint32) | | | +| five_qi | [int32](#int32) | | | +| ueid | [UeIdentity](#onos-ransim-types-UeIdentity) | | | + + + + + + + + +### UeIdentity + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guami | [Guami](#onos-ransim-types-Guami) | | | +| amf_ue_ngap_id | [uint64](#uint64) | | | + + + + + + + + +### UeMetrics + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| ho_latency | [int64](#int64) | | Latency (in nanoseconds) of the most recent hand-over | +| ho_report_timestamp | [int64](#int64) | | Handover report timestamp (in nanoseconds since epoch) | +| is_first | [bool](#bool) | | flag to indicate the first measurement | + + + + + + + + + + +### CellType + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| FEMTO | 0 | | +| ENTERPRISE | 1 | | +| OUTDOOR_SMALL | 2 | | +| MACRO | 3 | | + + + + + + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | 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 | int32 | int | integer | Bignum or Fixnum (as required) | +| 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 | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/onos-api/docs/onos/rsm/rsm.md b/onos-api/docs/onos/rsm/rsm.md new file mode 100644 index 0000000..7ae53d9 --- /dev/null +++ b/onos-api/docs/onos/rsm/rsm.md @@ -0,0 +1,319 @@ +# Protocol Documentation + + +## Table of Contents + +- [onos/rsm/rsm.proto](#onos_rsm_rsm-proto) + - [Ack](#onos-rsm-Ack) + - [CreateSliceRequest](#onos-rsm-CreateSliceRequest) + - [CreateSliceResponse](#onos-rsm-CreateSliceResponse) + - [DeleteSliceRequest](#onos-rsm-DeleteSliceRequest) + - [DeleteSliceResponse](#onos-rsm-DeleteSliceResponse) + - [SetUeSliceAssociationRequest](#onos-rsm-SetUeSliceAssociationRequest) + - [SetUeSliceAssociationResponse](#onos-rsm-SetUeSliceAssociationResponse) + - [SliceAssocItem](#onos-rsm-SliceAssocItem) + - [SliceItem](#onos-rsm-SliceItem) + - [UeId](#onos-rsm-UeId) + - [UpdateSliceRequest](#onos-rsm-UpdateSliceRequest) + - [UpdateSliceResponse](#onos-rsm-UpdateSliceResponse) + + - [SchedulerType](#onos-rsm-SchedulerType) + - [SliceType](#onos-rsm-SliceType) + - [UeIdType](#onos-rsm-UeIdType) + + - [Rsm](#onos-rsm-Rsm) + +- [Scalar Value Types](#scalar-value-types) + + + + + + +## onos/rsm/rsm.proto + + + + + +### Ack + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| success | [bool](#bool) | | | +| cause | [string](#string) | | | + + + + + + + + +### CreateSliceRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| e2_node_id | [string](#string) | | | +| slice_id | [string](#string) | | | +| scheduler_type | [SchedulerType](#onos-rsm-SchedulerType) | | | +| weight | [string](#string) | | | +| sliceType | [SliceType](#onos-rsm-SliceType) | | | + + + + + + + + +### CreateSliceResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| ack | [Ack](#onos-rsm-Ack) | | | + + + + + + + + +### DeleteSliceRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| e2_node_id | [string](#string) | | | +| slice_id | [string](#string) | | | +| sliceType | [SliceType](#onos-rsm-SliceType) | | | + + + + + + + + +### DeleteSliceResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| ack | [Ack](#onos-rsm-Ack) | | | + + + + + + + + +### SetUeSliceAssociationRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| e2_node_id | [string](#string) | | | +| ue_id | [UeId](#onos-rsm-UeId) | repeated | | +| dl_slice_id | [string](#string) | | | +| ul_slice_id | [string](#string) | | | +| drb_id | [string](#string) | | | + + + + + + + + +### SetUeSliceAssociationResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| ack | [Ack](#onos-rsm-Ack) | | | +| assigned_ue_slice_assoc_id | [string](#string) | | | + + + + + + + + +### SliceAssocItem + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| ue_slice_assoc_id | [string](#string) | | | +| e2_node_id | [string](#string) | | | +| ue_id | [UeIdType](#onos-rsm-UeIdType) | repeated | | +| slice_id | [string](#string) | | | + + + + + + + + +### SliceItem + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| e2_node_id | [string](#string) | | | +| slice_ids | [string](#string) | repeated | | + + + + + + + + +### UeId + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| ue_id | [string](#string) | | | +| type | [UeIdType](#onos-rsm-UeIdType) | | | + + + + + + + + +### UpdateSliceRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| e2_node_id | [string](#string) | | | +| slice_id | [string](#string) | | | +| scheduler_type | [SchedulerType](#onos-rsm-SchedulerType) | | | +| weight | [string](#string) | | | +| sliceType | [SliceType](#onos-rsm-SliceType) | | | + + + + + + + + +### UpdateSliceResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| ack | [Ack](#onos-rsm-Ack) | | | + + + + + + + + + + +### SchedulerType + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| SCHEDULER_TYPE_ROUND_ROBIN | 0 | | +| SCHEDULER_TYPE_PROPORTIONALLY_FAIR | 1 | | +| SCHEDULER_TYPE_QOS_BASED | 2 | | + + + + + +### SliceType + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| SLICE_TYPE_DL_SLICE | 0 | | +| SLICE_TYPE_UL_SLICE | 1 | | + + + + + +### UeIdType + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| UE_ID_TYPE_CU_UE_F1_AP_ID | 0 | | +| UE_ID_TYPE_DU_UE_F1_AP_ID | 1 | | +| UE_ID_TYPE_RAN_UE_NGAP_ID | 2 | | +| UE_ID_TYPE_AMF_UE_NGAP_ID | 3 | | +| UE_ID_TYPE_ENB_UE_S1_AP_ID | 4 | | + + + + + + + + + +### Rsm + + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| CreateSlice | [CreateSliceRequest](#onos-rsm-CreateSliceRequest) | [CreateSliceResponse](#onos-rsm-CreateSliceResponse) | Slice management | +| UpdateSlice | [UpdateSliceRequest](#onos-rsm-UpdateSliceRequest) | [UpdateSliceResponse](#onos-rsm-UpdateSliceResponse) | | +| DeleteSlice | [DeleteSliceRequest](#onos-rsm-DeleteSliceRequest) | [DeleteSliceResponse](#onos-rsm-DeleteSliceResponse) | | +| SetUeSliceAssociation | [SetUeSliceAssociationRequest](#onos-rsm-SetUeSliceAssociationRequest) | [SetUeSliceAssociationResponse](#onos-rsm-SetUeSliceAssociationResponse) | UE-Slice association | + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | 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 | int32 | int | integer | Bignum or Fixnum (as required) | +| 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 | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/onos-api/docs/onos/topo/topo.md b/onos-api/docs/onos/topo/topo.md new file mode 100644 index 0000000..3c71692 --- /dev/null +++ b/onos-api/docs/onos/topo/topo.md @@ -0,0 +1,582 @@ +# Protocol Documentation + + +## Table of Contents + +- [onos/topo/topo.proto](#onos_topo_topo-proto) + - [CreateRequest](#onos-topo-CreateRequest) + - [CreateResponse](#onos-topo-CreateResponse) + - [DeleteRequest](#onos-topo-DeleteRequest) + - [DeleteResponse](#onos-topo-DeleteResponse) + - [Entity](#onos-topo-Entity) + - [EqualFilter](#onos-topo-EqualFilter) + - [Event](#onos-topo-Event) + - [Filter](#onos-topo-Filter) + - [Filters](#onos-topo-Filters) + - [GetRequest](#onos-topo-GetRequest) + - [GetResponse](#onos-topo-GetResponse) + - [InFilter](#onos-topo-InFilter) + - [Kind](#onos-topo-Kind) + - [ListRequest](#onos-topo-ListRequest) + - [ListResponse](#onos-topo-ListResponse) + - [NotFilter](#onos-topo-NotFilter) + - [Object](#onos-topo-Object) + - [Object.AspectsEntry](#onos-topo-Object-AspectsEntry) + - [Object.LabelsEntry](#onos-topo-Object-LabelsEntry) + - [QueryRequest](#onos-topo-QueryRequest) + - [QueryResponse](#onos-topo-QueryResponse) + - [Relation](#onos-topo-Relation) + - [RelationFilter](#onos-topo-RelationFilter) + - [UpdateRequest](#onos-topo-UpdateRequest) + - [UpdateResponse](#onos-topo-UpdateResponse) + - [WatchRequest](#onos-topo-WatchRequest) + - [WatchResponse](#onos-topo-WatchResponse) + + - [EventType](#onos-topo-EventType) + - [Object.Type](#onos-topo-Object-Type) + - [RelationFilterScope](#onos-topo-RelationFilterScope) + - [SortOrder](#onos-topo-SortOrder) + + - [Topo](#onos-topo-Topo) + +- [Scalar Value Types](#scalar-value-types) + + + + + + +## onos/topo/topo.proto + + + + + +### CreateRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| object | [Object](#onos-topo-Object) | | | + + + + + + + + +### CreateResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| object | [Object](#onos-topo-Object) | | | + + + + + + + + +### DeleteRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | | +| revision | [uint64](#uint64) | | | + + + + + + + + +### DeleteResponse + + + + + + + + + +### Entity +Entity represents any "thing" that is represented in the topology + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| kind_id | [string](#string) | | user-defined entity kind | +| src_relation_ids | [string](#string) | repeated | these lists are maintained by the system and are provided as read-only values for clients | +| tgt_relation_ids | [string](#string) | repeated | | + + + + + + + + +### EqualFilter + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| value | [string](#string) | | | + + + + + + + + +### Event +Event is a topo operation event + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| type | [EventType](#onos-topo-EventType) | | | +| object | [Object](#onos-topo-Object) | | | + + + + + + + + +### Filter + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| equal | [EqualFilter](#onos-topo-EqualFilter) | | | +| not | [NotFilter](#onos-topo-NotFilter) | | | +| in | [InFilter](#onos-topo-InFilter) | | | +| key | [string](#string) | | optional key | + + + + + + + + +### Filters + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| kind_filter | [Filter](#onos-topo-Filter) | | | +| label_filters | [Filter](#onos-topo-Filter) | repeated | | +| relation_filter | [RelationFilter](#onos-topo-RelationFilter) | | | +| object_types | [Object.Type](#onos-topo-Object-Type) | repeated | | +| with_aspects | [string](#string) | repeated | | + + + + + + + + +### GetRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | | + + + + + + + + +### GetResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| object | [Object](#onos-topo-Object) | | | + + + + + + + + +### InFilter + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| values | [string](#string) | repeated | | + + + + + + + + +### Kind +Kind represents an archetype of an object, i.e. entity or relation + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | Friendly name of the kind | + + + + + + + + +### ListRequest +DEPRECATED + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| filters | [Filters](#onos-topo-Filters) | | | +| sort_order | [SortOrder](#onos-topo-SortOrder) | | | + + + + + + + + +### ListResponse +DEPRECATED + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| objects | [Object](#onos-topo-Object) | repeated | | + + + + + + + + +### NotFilter + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| inner | [Filter](#onos-topo-Filter) | | | + + + + + + + + +### Object +Object is an one of the following: a kind (archetype of entity or relation), an entity, a relation + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| uuid | [string](#string) | | | +| id | [string](#string) | | | +| revision | [uint64](#uint64) | | | +| type | [Object.Type](#onos-topo-Object-Type) | | | +| entity | [Entity](#onos-topo-Entity) | | | +| relation | [Relation](#onos-topo-Relation) | | | +| kind | [Kind](#onos-topo-Kind) | | | +| aspects | [Object.AspectsEntry](#onos-topo-Object-AspectsEntry) | repeated | Map of aspects as typed values; for kind, these represent expected aspects and their default values | +| labels | [Object.LabelsEntry](#onos-topo-Object-LabelsEntry) | repeated | Arbitrary labels for classification/search | + + + + + + + + +### Object.AspectsEntry + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [google.protobuf.Any](#google-protobuf-Any) | | | + + + + + + + + +### Object.LabelsEntry + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [string](#string) | | | + + + + + + + + +### QueryRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| filters | [Filters](#onos-topo-Filters) | | | + + + + + + + + +### QueryResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| object | [Object](#onos-topo-Object) | | | + + + + + + + + +### Relation +Relation represents any "relation" between two entitites in the topology. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| kind_id | [string](#string) | | user defined relation kind | +| src_entity_id | [string](#string) | | | +| tgt_entity_id | [string](#string) | | | + + + + + + + + +### RelationFilter +Filter for targets of given relation kinds and given source ids; optionally, filters by specified target kind + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| src_id | [string](#string) | | | +| relation_kind | [string](#string) | | | +| target_kind | [string](#string) | | | +| scope | [RelationFilterScope](#onos-topo-RelationFilterScope) | | | +| target_id | [string](#string) | | | + + + + + + + + +### UpdateRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| object | [Object](#onos-topo-Object) | | | + + + + + + + + +### UpdateResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| object | [Object](#onos-topo-Object) | | | + + + + + + + + +### WatchRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| filters | [Filters](#onos-topo-Filters) | | | +| noreplay | [bool](#bool) | | | + + + + + + + + +### WatchResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| event | [Event](#onos-topo-Event) | | | + + + + + + + + + + +### EventType +EventType is a topo operation event type + +| Name | Number | Description | +| ---- | ------ | ----------- | +| NONE | 0 | | +| ADDED | 1 | | +| UPDATED | 2 | | +| REMOVED | 3 | | + + + + + +### Object.Type + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| UNSPECIFIED | 0 | | +| ENTITY | 1 | | +| RELATION | 2 | | +| KIND | 3 | | + + + + + +### RelationFilterScope + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| TARGETS_ONLY | 0 | Indicates only the target entities are desired when searching by src_id, or source entities when searching by target_id | +| ALL | 1 | Indicated source, target entities and all relations are desired | +| SOURCE_AND_TARGETS | 2 | Indicates only source and target entities are desired, regardless of search criteria | +| RELATIONS_ONLY | 3 | Indicates only relations are desired; no entities | +| RELATIONS_AND_TARGETS | 4 | Indicates only relations and target entities desired when searching by src_id, or relations and source entities when searching by target_id | + + + + + +### SortOrder + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| UNORDERED | 0 | | +| ASCENDING | 1 | | +| DESCENDING | 2 | | + + + + + + + + + +### Topo +EntityService provides an API for managing entities. + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| Create | [CreateRequest](#onos-topo-CreateRequest) | [CreateResponse](#onos-topo-CreateResponse) | Create a new topology object | +| Get | [GetRequest](#onos-topo-GetRequest) | [GetResponse](#onos-topo-GetResponse) | Get an object from topology | +| Update | [UpdateRequest](#onos-topo-UpdateRequest) | [UpdateResponse](#onos-topo-UpdateResponse) | Update an existing topology object | +| Delete | [DeleteRequest](#onos-topo-DeleteRequest) | [DeleteResponse](#onos-topo-DeleteResponse) | Delete an object from topology | +| Query | [QueryRequest](#onos-topo-QueryRequest) | [QueryResponse](#onos-topo-QueryResponse) stream | Query gets a stream of requested objects | +| List | [ListRequest](#onos-topo-ListRequest) | [ListResponse](#onos-topo-ListResponse) | DEPRECATED: List gets a list of requested objects | +| Watch | [WatchRequest](#onos-topo-WatchRequest) | [WatchResponse](#onos-topo-WatchResponse) stream | Watch returns a stream of topo change notifications | + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | 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 | int32 | int | integer | Bignum or Fixnum (as required) | +| 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 | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/onos-api/docs/onos/uenib/uenib.md b/onos-api/docs/onos/uenib/uenib.md new file mode 100644 index 0000000..8046684 --- /dev/null +++ b/onos-api/docs/onos/uenib/uenib.md @@ -0,0 +1,312 @@ +# Protocol Documentation + + +## Table of Contents + +- [onos/uenib/uenib.proto](#onos_uenib_uenib-proto) + - [CreateUERequest](#onos-uenib-CreateUERequest) + - [CreateUEResponse](#onos-uenib-CreateUEResponse) + - [DeleteUERequest](#onos-uenib-DeleteUERequest) + - [DeleteUEResponse](#onos-uenib-DeleteUEResponse) + - [Event](#onos-uenib-Event) + - [GetUERequest](#onos-uenib-GetUERequest) + - [GetUEResponse](#onos-uenib-GetUEResponse) + - [ListUERequest](#onos-uenib-ListUERequest) + - [ListUEResponse](#onos-uenib-ListUEResponse) + - [UE](#onos-uenib-UE) + - [UE.AspectsEntry](#onos-uenib-UE-AspectsEntry) + - [UpdateUERequest](#onos-uenib-UpdateUERequest) + - [UpdateUEResponse](#onos-uenib-UpdateUEResponse) + - [WatchUERequest](#onos-uenib-WatchUERequest) + - [WatchUEResponse](#onos-uenib-WatchUEResponse) + + - [EventType](#onos-uenib-EventType) + + - [UEService](#onos-uenib-UEService) + +- [Scalar Value Types](#scalar-value-types) + + + + + + +## onos/uenib/uenib.proto + + + + + +### CreateUERequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| ue | [UE](#onos-uenib-UE) | | | + + + + + + + + +### CreateUEResponse + + + + + + + + + +### DeleteUERequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | | +| aspect_types | [string](#string) | repeated | | + + + + + + + + +### DeleteUEResponse + + + + + + + + + +### Event +Event is a record of an operation on a UE + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| type | [EventType](#onos-uenib-EventType) | | | +| ue | [UE](#onos-uenib-UE) | | | + + + + + + + + +### GetUERequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | | +| aspect_types | [string](#string) | repeated | | + + + + + + + + +### GetUEResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| ue | [UE](#onos-uenib-UE) | | | + + + + + + + + +### ListUERequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| aspect_types | [string](#string) | repeated | | + + + + + + + + +### ListUEResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| ue | [UE](#onos-uenib-UE) | | | + + + + + + + + +### UE +UE entity is merely an ID and a map of arbitrary aspects. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | | +| aspects | [UE.AspectsEntry](#onos-uenib-UE-AspectsEntry) | repeated | Map of aspects as typed values | + + + + + + + + +### UE.AspectsEntry + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [google.protobuf.Any](#google-protobuf-Any) | | | + + + + + + + + +### UpdateUERequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| ue | [UE](#onos-uenib-UE) | | | + + + + + + + + +### UpdateUEResponse + + + + + + + + + +### WatchUERequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| noreplay | [bool](#bool) | | | +| aspect_types | [string](#string) | repeated | | + + + + + + + + +### WatchUEResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| event | [Event](#onos-uenib-Event) | | | + + + + + + + + + + +### EventType +EventType is a UE operation event type + +| Name | Number | Description | +| ---- | ------ | ----------- | +| NONE | 0 | | +| ADDED | 1 | | +| UPDATED | 2 | | +| REMOVED | 3 | | + + + + + + + + + +### UEService +UEService provides an API for managing UEs and various aspects of +information associated with UEs. + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| CreateUE | [CreateUERequest](#onos-uenib-CreateUERequest) | [CreateUEResponse](#onos-uenib-CreateUEResponse) | Create a new UE entity and its initial set of aspects. | +| GetUE | [GetUERequest](#onos-uenib-GetUERequest) | [GetUEResponse](#onos-uenib-GetUEResponse) | Get a UE entity populated with the requested aspects. | +| UpdateUE | [UpdateUERequest](#onos-uenib-UpdateUERequest) | [UpdateUEResponse](#onos-uenib-UpdateUEResponse) | Update an existing UE entity populated with the requested aspects. Only the aspects present in the UE entity will be updated; others will be left unmodified. New aspects can be added via update. | +| DeleteUE | [DeleteUERequest](#onos-uenib-DeleteUERequest) | [DeleteUEResponse](#onos-uenib-DeleteUEResponse) | Delete the specified aspects of a UE entity. | +| ListUEs | [ListUERequest](#onos-uenib-ListUERequest) | [ListUEResponse](#onos-uenib-ListUEResponse) stream | ListUEs returns a stream of UE entities populated the requested aspects. | +| WatchUEs | [WatchUERequest](#onos-uenib-WatchUERequest) | [WatchUEResponse](#onos-uenib-WatchUEResponse) stream | WatchUEs returns a stream of UE change notifications, with each UE populated with only the requested aspects. | + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | 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 | int32 | int | integer | Bignum or Fixnum (as required) | +| 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 | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/onos-cli/README.md b/onos-cli/README.md new file mode 100644 index 0000000..32faf0f --- /dev/null +++ b/onos-cli/README.md @@ -0,0 +1,20 @@ + + +# onos-cli +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/onosproject/onos-cli/blob/master/LICENSE) +[![Go Report Card](https://goreportcard.com/badge/github.com/onosproject/onos-cli)](https://goreportcard.com/report/github.com/onosproject/onos-cli) +[![GoDoc](https://godoc.org/github.com/onosproject/onos-cli?status.svg)](https://godoc.org/github.com/onosproject/onos-cli) + +This is the implementation of a consolidated `onos` command-line interface for ONOS (µONOS Architecture) + +The goal is to provide a single CLI executable that can be used as a means to access CLI functionality +of a number of different ONOS subsystems, e.g. topo, config, control. + +* [Deploying onos-cli with Helm](docs/deployment.md) +* [ONOS command line client](docs/cli/onos.md) + + + diff --git a/onos-cli/docs/cli/onos.md b/onos-cli/docs/cli/onos.md new file mode 100644 index 0000000..2783cd3 --- /dev/null +++ b/onos-cli/docs/cli/onos.md @@ -0,0 +1,36 @@ + + +## onos + +ONOS command line client + +### Options + +``` + -h, --help help for onos +``` + +### SEE ALSO + +* [onos a1t](onos_a1t.md) - ONOS a1t subsystem commands +* [onos completion](onos_completion.md) - Generated bash or zsh auto-completion script +* [onos config](onos_config.md) - ONOS configuration subsystem commands +* [onos discovery](onos_discovery.md) - Topology discovery subsystem commands +* [onos e2t](onos_e2t.md) - ONOS e2t subsystem commands +* [onos fabric-sim](onos_fabric-sim.md) - ONOS fabric simulator commands +* [onos kpimon](onos_kpimon.md) - ONOS KPIMON subsystem commands +* [onos mho](onos_mho.md) - ONOS MHO subsystem commands +* [onos mlb](onos_mlb.md) - ONOS MLB subsystem commands +* [onos pci](onos_pci.md) - ONOS PCI subsystem commands +* [onos perf](onos_perf.md) - simple gRPC performance measurement client +* [onos provisioner](onos_provisioner.md) - Device provisioner subsystem commands +* [onos ransim](onos_ransim.md) - ONOS RAN simulator commands +* [onos rsm](onos_rsm.md) - ONOS RSM subsystem commands +* [onos topo](onos_topo.md) - ONOS topology resource commands +* [onos uenib](onos_uenib.md) - ONOS UE-NIB subsystem commands + +###### Auto generated by spf13/cobra on 29-Jun-2024 diff --git a/onos-cli/docs/cli/onos_a1t.md b/onos-cli/docs/cli/onos_a1t.md new file mode 100644 index 0000000..642eb28 --- /dev/null +++ b/onos-cli/docs/cli/onos_a1t.md @@ -0,0 +1,27 @@ + + +## onos a1t + +ONOS a1t subsystem commands + +### Options + +``` + --auth-header string Auth header in the form 'Bearer