broker.mqtt

Mqtt broker

type	object
properties
templateId	The id of the template to use for this file
	type	string
templateVariables	The variables and their values to be replaced from the template
	type	object
	additionalProperties
variablesFiles	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
isTemplateGeneratedByOspComposer	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
moduleId	The id of the module.
	type	string
hostname	The ip or hostname to use to connect to the broker.
	type	string
port	The port to use to connect to the broker.
	type	integer
	maximum	65535
	minimum	1
	default	1883
version	The mqtt version to use.
	type	string
	enum	V3, V5
	default	V3
username	The username to use with the broker
	type	string
credential	The credential to connect to the broker.
	default	type	NONE
	oneOf	PASSWORD
		CERT
		NONE
useTLS	Use TLS as transport layer to connect to the broker.
	type	boolean
	default	False
insecure	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	type	string
	enum	PASSWORD
	default	PASSWORD
passwordProvider	The password to the broker.
	oneOf	PLAINTEXT
		SECRET
additionalProperties	False

PLAINTEXT

type	object
properties
type	type	string
	enum	PLAINTEXT
	default	PLAINTEXT
password	The password to use in plaintext. It can be for example thisIs@TestPassword123.
	type	string
additionalProperties	False

SECRET

type	object
properties
type	type	string
	enum	SECRET
	default	SECRET
secretPath	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	type	string
	enum	CERT
	default	CERT
publicKeyName	The public certificate for the authentication from the OSP client. The resource file need to place the key in the folder external/. For example, the file test.crt must be added: The publicKeyName field will be <optional sub folder>/test.crt The module.resources will be { "resources": [ { "source": "<relative path on git>/test.crt", "destination": "external/<optional sub folder>/test.crt" } ] }
	type	string
privateKeyName	The private key for the authentication from the OSP client. The resource file need to place the key in the folder keys/. For example, the file test.key must be added: The privateKeyName field will be <optional sub folder>/test.key The module.resources will be { "resources": [ { "source": "<relative path on git>/test.key", "destination": "keys/<optional sub folder>/test.key" } ] }
	type	string
caName	The CA (public key) used for the generation of the client certificate
	type	string
passwordProvider	The password to the broker.
	oneOf	PLAINTEXT
		SECRET
additionalProperties	False

NONE

type	object
properties
type	type	string
	enum	NONE
	default	NONE
additionalProperties	False