Server-level data source parameters

hostNameOrIpAddress

Required

string

Host name or IP address of the server.

Allowed value: Any valid WS or TCP/IP endpoint address
Default value: null

port

Optional

integer

Port number of the server. Required only if Protocol is TCP.

Allowed value: Valid port range or null
Default value if Protocol is TCP: 8883
Default value if Protocol is WS: null

protocol

Optional

enum

The protocol used to communicate to the broker.

Allowed value: WS or TCP
Default value: TCP

tls

Optional

enum

Determines if TLS should be used and what version.

Allowed value: None, TLS, TLS11, TLS12, TLS13
Default value: TLS12

userName

Optional

string

User name or client Id for accessing the server.

Allowed value: any string
Default value: null

password

Optional

string

Password or token for accessing the server.

Note: We recommend using REST to configure the data source when the password must be specified because the adapter encrypts the password when using REST. If you do not use REST, the plain text password is stored on-disk. You cannot specify a password without specifying a userName.

Allowed value: Any string
Default value: null

clientCertificateThumbprint

Optional

string

The thumbprint of the certificate when the broker requires a client certificate.

Default value: null

clientCertificatePassword

Optional

string

(Protected) - The password to access the certificate when the broker requires a client certificate.

Default value: null

validateServerCertificate

Optional

boolean

Determines if the server certificate gets validated.

Note: A warning is printed in case the server certificate validation is disabled.

Default value: true

serverID

Optional

string

Unique GUID for the Server.