broker.mqtt¶
Mqtt broker¶
type |
object |
||
properties |
|||
|
The id of the template to use for this file |
||
type |
string |
||
|
The variables and their values to be replaced from the template |
||
type |
object |
||
additionalProperties |
|||
|
The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files. |
||
type |
array |
||
items |
type |
string |
|
|
If the value is set to true, manual editing of this file should be avoided, as the composer will override the value in the next generation. |
||
type |
boolean |
||
|
The id of the module. |
||
type |
string |
||
|
The ip or hostname to use to connect to the broker. |
||
type |
string |
||
|
The port to use to connect to the broker. |
||
type |
integer |
||
maximum |
65535 |
||
minimum |
1 |
||
default |
1883 |
||
|
The mqtt version to use. |
||
type |
string |
||
enum |
V3, V5 |
||
default |
V3 |
||
|
The username to use with the broker |
||
type |
string |
||
|
The credential to connect to the broker. |
||
default |
type |
NONE |
|
oneOf |
|||
|
Use TLS as transport layer to connect to the broker. |
||
type |
boolean |
||
default |
False |
||
|
Allow insecure TLS connection to broker. This will disable hostname validation upon receiving server certificate. Broker certificate still need to be provided as external certificate. |
||
type |
boolean |
||
default |
False |
||
additionalProperties |
False |
PASSWORD¶
type |
object |
|
properties |
||
|
type |
string |
enum |
PASSWORD |
|
default |
PASSWORD |
|
|
The password to the broker. |
|
oneOf |
||
additionalProperties |
False |
PLAINTEXT¶
type |
object |
|
properties |
||
|
type |
string |
enum |
PLAINTEXT |
|
default |
PLAINTEXT |
|
|
The password to use in plaintext. It can be for example thisIs@TestPassword123. |
|
type |
string |
|
additionalProperties |
False |
SECRET¶
type |
object |
|
properties |
||
|
type |
string |
enum |
SECRET |
|
default |
SECRET |
|
|
The path of the secret containing the password. This is a path to the secret containing the password. |
|
type |
string |
|
additionalProperties |
False |
CERT¶
type |
object |
|
properties |
||
|
type |
string |
enum |
CERT |
|
default |
CERT |
|
|
The private key for the authentication from the OSP client. |
|
type |
string |
|
|
The public key for the authentication from the OSP client. |
|
type |
string |
|
|
The CA (public key) used for the generation of the client certificate |
|
type |
string |
|
|
The password to the broker. |
|
oneOf |
||
additionalProperties |
False |
NONE¶
type |
object |
|
properties |
||
|
type |
string |
enum |
NONE |
|
default |
NONE |
|
additionalProperties |
False |