Skip to content

Network Service

The Network Service is a gRPC & Go based network configuration service. The network settings of the Edge Devices are configured through this service.

Table of Contents

Top

Network.proto

Interface

Interface type holds settings for a Network Interface.

Field Type Label Description
GatewayInterface bool if true, route metric will be set to 1. Otherwise route metric is -1. Similarly, when the interface is requested,return value will be true if route metric is 1.
MacAddress string "20:87:56:b5:ed:e0"
DHCP string values can be 'enabled' or 'disabled'. for compatiblity reasons it is not boolean.
Static Interface.StaticConf Static field is StaticConf type instance.
DNSConfig Interface.Dns DNSConfig is dns type instance.
L2Conf Interface.L2
GsmConfiguration Interface.GsmConf Contains the required configuration for the cellular module.
InterfaceType Interface.InterfaceTypeEnum optional Optional interface type (ETHERNET = 0, GSM = 1).
InterfaceName string Network interface name e.g: "enp2s0"
Label string Label for the interface e.g: "X1"
Routes Interface.Route Extra IPv4 routes defined on this interface.

These attributes are used by /info GET API in Industrial Edge Device API 2.4.2

Interface.Dns

Type that contains Primary and Secondary DNS.

Field Type Label Description
PrimaryDNS string e.g: "1.1.1.2"
SecondaryDNS string e.g: "1.1.1.1"

Interface.L2

Field Type Label Description
StartingAddressIPv4 string e.g: 192.168.0.2
NetMask string e.g: 255.255.255.0
Range string e.g: 16
Gateway string e.g: 192.168.2.1
AuxiliaryAddresses Interface.L2.AuxiliaryAddressesEntry repeated Preserved addresses for other devices. These addresses won't be assigned to containers. e.g my_plc, 192.168.0.5

Interface.L2.AuxiliaryAddressesEntry

Field Type Label Description
key string
value string

Interface.StaticConf

StaticConf type holds IP Netmask and Gateway information

Field Type Label Description
IPv4 string e.g: 192.168.0.2
NetMask string e.g: 255.255.255.0
Gateway string e.g: 192.168.0.1

Interface.Route

Field Type Label Description
Destination string Required. Destination network IP address. I.e. 192.168.1.0.
Netmask string Optional. IP mask of the destination network. I.e. 255.255.255.0. Default: 255.255.255.255.
NextHop string Optional. IP address of the peer to route via.
Metric uint32 Opitonal. Metric value of the route for prioritization.

Interface.GsmConf

GsmConf type holds cellular module configurations

Field Type Label Description
Apn string e.g: web.vodafone.de
Pin string e.g: 1234
Username string
Password string

Interface.InterfaceTypeEnum

Valid values for the interface type.

Name Value Description
ETHERNET 0 Ethernet network interface
GSM 1 Cellular network interface

NetworkInterfaceRequest

Contains MAC address, used for retrieving specified Network Interface settings.

Field Type Label Description
mac string

NetworkInterfaceRequestWithLabel

Returns an Network Interface with

Field Type Label Description
label string

NetworkSettings

Contains multiple network interface settings. It can be used to apply or get the settings.

Field Type Label Description
Interfaces Interface repeated Network settings contains an array of Interfaces.Applying new settings or receiving current settings is supported for multiple ethernet typed network interfaces supported.
LabelMap NetworkSettings.LabelMapEntry repeated LabelMap contains port label and corresponding interface-name. e.g key : x1 value: enp2s0

NetworkSettings.LabelMapEntry

Field Type Label Description
key string
value string

ConnectionSettings

Contains configurations for creating and removing a network connection

Field Type Label Description
Name string Connection name, e.g: "Cellular Connection 1"
connection_type ConnectionType Connection type.
connection_config oneof Connection-specific configuration payload.
gsm Interface.GsmConf oneof (connection_config) GSM connection configuration (used when connection_type is GSM).

ConnectionSettings.ConnectionType

Valid values for the connection type.

Name Value Description
UNKNOWN 0 Unspecified connection type
GSM 1 GSM-type connection

NetworkService

Network service ,uses a UNIX Domain Socket "/var/run/devicemodel/network.sock" for GRPC communication. protoc generates both client and server instance for this Service. GRPC Status codes : https://developers.google.com/maps-booking/reference/grpc-api/status_codes .

Method Name Request Type Response Type Description
GetAllInterfaces [.google.protobuf.Empty](#google.protobuf.Empty) [NetworkSettings](#siemens.iedge.dmapi.network.v1.NetworkSettings) Returns the settings of all ethernet typed network interfaces
GetInterfaceWithMac [NetworkInterfaceRequest](#siemens.iedge.dmapi.network.v1.NetworkInterfaceRequest) [Interface](#siemens.iedge.dmapi.network.v1.Interface) Returns the current setting for the interface, with given MAC address.
GetInterfaceWithLabel [NetworkInterfaceRequestWithLabel](#siemens.iedge.dmapi.network.v1.NetworkInterfaceRequestWithLabel) [Interface](#siemens.iedge.dmapi.network.v1.Interface) Returns the current setting for the interface, with given Label.
ApplySettings [NetworkSettings](#siemens.iedge.dmapi.network.v1.NetworkSettings) [.google.protobuf.Empty](#google.protobuf.Empty) Applies given configurations to Network Interfaces.
CreateConnection ConnectionSettings [.google.protobuf.Empty](#google.protobuf.Empty) Creates a network connection based on the provided configuration.
RemoveConnection ConnectionSettings [.google.protobuf.Empty](#google.protobuf.Empty) Removes a network connection based on the provided configuration.

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)

Funding Acknowledgment: Funded by the Federal Ministry for Economic Affairs and Energy based on a decision by the German Bundestag | Your funding provider: Kicks for Edge as part of the EU funding program IPCEI-CIS (FKZ:13IPC008)
Funding Logo