.. _vnx.opc_ua.Server:

vnx.opc_ua.Server
=================

.. cpp:namespace:: vnx::opc_ua::Server

Module
------

The `vnx.opc_ua.Server` module provides a OPC-UA server to interface with the running process.

Depending on the configuration different modules and topics are offered on the OPC-UA interface.


Options
-------

.. cpp:member:: uint port = 4840

	The port number the server binds to.

.. cpp:member:: set<string> export_services
	
	List of modues to offer on the OPC-UA interface as objects.
	
.. cpp:member:: set<string> export_topics
	
	List of topics to offer on the OPC-UA interface as variables.

.. cpp:member:: string certificate_file

	Optional path to a server certificate file (DER format).

.. cpp:member:: string private_key_file = ""

	Optional path to a server private key file (DER format).

.. cpp:member:: string application_uri = "urn:open62541.server.application";

	Must match the URI in the certificate.

.. cpp:member:: vector<string> trust_list

	Client certificate trust files (CRL format).
	This only has an effect if a server certificate is configured.
	If the list is empty, any certificate is accepted.

.. cpp:member:: bool allow_anonymous_access = true

	Allow access without authentication.

.. cpp:member:: bool add_insecure_discovery = true

	Allow discovery with security policy ``NONE`` even if not configured.
	This is necessary if you want a secure server (i.e. no ``NONE`` policy)
	that can still be discovered by a client.
	If security policy ``NONE`` `is` configured, this option has no effect.

.. cpp:member:: vector<security_policy_e> security_policies

	A list of the security/encryption policies to provide.
	Most policies require a certificate and a private key.
	See :ref:`vnx.opc_ua.security_policy_e`

.. cpp:member:: bool use_authentication = false
	
	If to require authentication from clients. (Not implemented yet)
	
.. cpp:member:: string default_access = "DEFAULT"
	
	Default access level for anonymous clients, see :ref:`users`.
	Only if `use_authentication = true`, otherwise there are no restrictions, ie. full permissions to any user.