The path to a file in order to write logging also to this file. The parent directory path must already exist and be writeable. If not specified or set to null file logging is not used.
level
Optional
String
WARN
ERROR
WARN
INFO
DEBUG
The level that is used for logging. If not specified, the default log level (WARN) is used. Verbose logging can be enabled when executing the run-gateway or run-backend start scripts using the -v option. This option can be used multiple times to enable the following log level:
When set to true the HTTP client of the CSE will not verify if the hostname of a remote CSE/server matches any of the entries in the subjectAltName or commonName of the certificate.
TODO: DEFAULT VALUE; if missing in config => geventhttpclient connectionpool: "if not self.insecure (None)" will every time check if match of hostname and peercert info
cse_base
Optional
String
onem2m
The name of the <CSEBase> resource.
cse_id
Optional
String
mn-cse-1
The unique identifier of the CSE.
cse_type
Optional
String
MN-CSE
IN_CSE
MN_CSE
AEN_CSE
The type of the CSE.
overwrite_originator
Optional
Enables to overwrite the originator information of the CSE. Instead of using the sp_id and cse_id which is set in the onem2m section of the config, the originator specified by overwrite_originator.originator is used. May be applied, when using certificates to match the originator of the CSE and the originator included in the certificate using the subjectAltName.
overwrite_originator.enabled
Optional
Boolean
false
true/false
Enables overwriting of the originator, if set to true.
overwrite_originator.originator
Optional
String
"" (empty string)
The originator which is used by the CSE when sending requests.
sp_id
Optional
String
openmtc.org
The unique identifier of the M2M Service Provider.
ssl_certs
?
When using SSL this section provides the private key, certificate and certificate chain.
ssl_certs.ca
?
String
The path of the certificate chain file.
TODO: fix when missing
ssl_certs.crt
?
String
The path of the certificate file.
TODO: fix when missing
ssl_certs.key
?
String
The path of the key file.
TODO: fix when missing
plugins.openmtc_cse
Plugins are what enriches the core component of OpenMTC with functionality.
The plugins section of the configuration file consists of a list ([...]) of plugin entries.
Each plugin entry is a JSON Object ({...}) which consists of the following common parameters:
Name
Mandatory/Optional
Type
Default
Description
name
Mandatory
String
The name of the class providing the plugin's functionality.
package
Mandatory
String
The fully qualified name of the Python where the plugin implementation resides.
disabled
Optional
Boolean
true
Set this to true to prevent a plugin from being loaded in the first place. Useful to disable a plugin without removing its configuration altogether.
config
Optional
Object
{}
The plugin specific configuration. Please see the documentation of individual plugins for details.
Enables secure HTTPS connections using the ssl certificate information provided in the *onem2m * section of the configuration file in the ssl_certs object. Only when ca, crt and key are given HTTPS is enabled.
config.interface
Optional
String
""
The HTTP/HTTPS server address.
config.port
Optional
Number
8000
The HTTP/HTTPS port.
config.require_cert
Boolean
true
true/false
If set to true, the client must provide a certificate.
NotificationHandler
Entities of the onem2m system can subscribe to resources. The NotificationHandler plugin sends notifications to the notificationURI attribute of the subscription whenever the subscribed resource is changed (created, updated, deleted).
The RegistrationHandler plugin registers a CSE with another CSEs.
Therefore, a remote CSE resource which contains information about the gateway CSE is created at the backend CSE.
Furthermore, a remote CSE resource which contains information about the backend CSE is created at gateway CSE.