broker.mqtt

Mqtt broker

type	object
properties
credential	The credential to connect to the broker. Default value is [{“type”:”NONE”}]
	default	type	NONE
	oneOf	PASSWORD
		CERT
		NONE
hostname	The ip or hostname to use to connect to the broker.
	type	string
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. Default value is [false]
	type	boolean
	default	False
isTemplateGeneratedByOspComposer	Name of the playbook that generated this file. If present, the file is managed by the Composer and may be overwritten on regeneration. Used for selective clean. Do not edit or set manually.
	type	string
moduleId	The id of the module.
	type	string
port	The port to use to connect to the broker. Default value is [1883]
	type	integer
	maximum	65535
	minimum	1
	default	1883
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
useTLS	Use TLS as transport layer to connect to the broker. Default value is [false]
	type	boolean
	default	False
username	The username to use with the broker
	type	string
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
version	The mqtt version to use. Default value is [“V3”]
	type	string
	enum	V3, V5
	default	V3
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	type	string
additionalProperties	False

SECRET

type	object
properties
type	type	string
	enum	SECRET
	default	SECRET
secretPath	type	string
additionalProperties	False

CERT

type	object
properties
type	type	string
	enum	CERT
	default	CERT
clientCertificate	The public certificate for the authentication from the OSP client. Default value is [{“caPath”:”ca.crt”,”privateKeyPath”:”module.key”,”providerType”:”SECRETS”,”publicKeyPath”:”module.crt”}]
	default	caPath	ca.crt
		privateKeyPath	module.key
		providerType	SECRETS
		publicKeyPath	module.crt
	ClientCertificate
passwordProvider	The password to the broker.
	oneOf	PLAINTEXT
		SECRET
additionalProperties	False

ClientCertificate

type	object
properties
caPath	The CA (public key) used for the generation of the client certificate
	type	string
privateKeyPath	The private key used for authentication by the OSP client is located at a path relative to either the secret directory or the base configuration file (which is /, not /root/).
	type	string
providerType	The following value are * SECRET : provided by the docker orchestrator (must be in /run/secrets folder) * CONFIG : the certificate is provided by the configuration In the example below the configuration of the key publicKeyPath is equals to the destination /test.crt { "resources": [ { "source": "</root/opc-certs/test.crt", "destination": "/test.crt" } ] }
	type	string
	enum	SECRETS, CONFIG
publicKeyPath	The public key used for authentication by the OSP client is located at a path relative to either the secret directory or the base configuration file (which is /, not /root/).
	type	string
additionalProperties	False

NONE

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