server.opc-da

OpcDa server

type	object
properties
connectionParameters	The connection settings to connect to the OpcDa server.
	OpcDaConnectionConfiguration
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 OPC DA module module.opc-da ↗️ that this server will refer to. For example modules.opc-da.opc-da-1 is the default OnSphere path of the OPC DA module.
	type	string
retryConnectionTimeout	The connection retry timeout. This will trigger a connection to the OPC DA server every `retryConnectionTimeout` until the server is reachable. Default value is [{“unit”:”MILLISECONDS”,”value”:500}]
	default	unit	MILLISECONDS
		value	500
	DurationConfigurationEntity
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
additionalProperties	False

type	object
properties
classId	The classId of the OpcDa Server.
	type	string
domain	The domain of the windows machine to connect to.
	type	string
host	The IP address of the OPC DA device. This address is used by the client to locate and connect to the OPC DA server on the network. For example, the host can be 192.168.42.1. Learn more about OPC UA ↗️.
	type	string
passwordProvider	The password to use for the connection to the server. It can be defined as plaintext or via a secret. Learn more about OPC DA ↗️.
	oneOf	PLAINTEXT
		SECRET
		ENCRYPTED
progId	The programmeId of the OpcDa Server. It is recommended to use the classId.
	type	string
readFrequency	The read frequency to update values that are read on the OpcDa server. Default value is [{“unit”:”MILLISECONDS”,”value”:500}]
	default	unit	MILLISECONDS
		value	500
	DurationConfigurationEntity
username	The username to use for the connection to the server. Is often the same as the windows user. It can be for example sysadmin. Learn more about OPC DA ↗️.
	type	string
additionalProperties	False

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

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

type	object
properties
type	type	string
	enum	ENCRYPTED
	default	ENCRYPTED
encryptedPassword	The password encrypted Base64(IV+AES256(password, input)) the password must be a shared secret available for the osp-configuration-dispatcher see documentation ↗️ see toolbox ↗️
	type	string
secretPath	The full path to the secret exposed by the orchestrator; this password is used to encrypt the encryptedPassword. see documentation ↗️ see toolbox ↗️
	type	string
additionalProperties	False

type	object
properties
unit	The unit of time expressed
	type	string
	enum	NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS
value	The amount of time expressed with the unit
	type	integer
additionalProperties	False