TCPChannel parameters

hostNameOrIpAddress

Required

string

IPv4 address or hostname that can be resolved to an IPv4 address. The adapter establishes a connection to this address.

port

Optional

number

TCP port that the outstations are listening on.

Default value: 20000

masterStationBehaviorId

Required

string

Must match the Id of one of the configurations in the MasterStationBehaviors list.

outstations

Required

array

List of outstations that the adapter connects to on the TCPChannel.

Note: A TCPChannel is uniquely identified by the combination of its HostNameOrIPAddress and Port properties. For valid configuration, each TCPChannel must have a unique combination of these properties.

serverCertificateDnsName

Optional

string

The subject name, which is verified in the presented server certificate, from the SAN extension or in the common name field.

The server verifies that TLSChannel.ServerPublicKey is valid for this name.

Note: This is only used when TCPChannel.CertificateValidationMode is set to CASigned

serverPublicKey

Optional

string

The file name or full path of the unencrypted PEM file containing the trusted root certificate(s) or the peer self-signed certificate.

tlsVersion

Optional

string

Minimum TLS version allowed.

If set, valid values are “None”, “1.2” or “1.3”.

Default: None

Note: If set to None, TLS encryption will not be used.

certificateValidationMode

Optional

enumeration

Valid values are CASigned and SelfSigned.

CASigned verifies that the root certificate is one provided in the ServerPublicKey.

SelfSigned validates that only a single certificate is present and is a direct match of the one specified in ServerPublicKey.

If this is set to SelfSigned, the validation of the certificate chain and the end-entity certificate of TCPChannel.TlsPeerCertificate is bypassed.

Default: CASigned