> For the complete documentation index, see [llms.txt](https://docs.frends.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.frends.com/tasks/tasks/opcua/read.md). # Read Task for reading data from OPCUA Server. Task version: 1.1.0 Required Frends version: 5.7+ Required .NET version: 8.0 Compatible Agents: Crossplatform Source code: ## Task Parameters {% tabs %} {% tab title="Input" %} | Name | Description | | ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Mode : `OpcOperationMode` |

Determines the mode for either reading specific nodes or browse existing nodes.

Possible values:


Default: Read
Example: OpcOperationMode.ReadNodes

| | NodeIds : `String[]` |

List of NodeIds to read from the OPC UA Server.


Default: -
Example: \[ "ns=2;i=1001", "ns=2;s=Temperature" ]

| | StartNodeId : `String` |

NodeId of the node where browsing should be started.


Default: -
Example: ns=2;s=Temperature

| | {% endtab %} | | {% tab title="Connection" %} | Name | Description | | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ServerName : `String` |

OPC UA Server name or IP address.


Default: localhost
Example: localhost

| | Port : `Int32` |

Port to be used to connect to the OPC UA Server.


Default: 4080
Example: 4080

| | Path : `String` |

Optional parameter to set a specific path to the server URL.


Default: -
Example: path

| | AutoAcceptUntrustedCertificates : `Boolean` |

Whether to accept untrusted/self-signed server certificates.

Set to false in production environments.


Default: True
Example: true

| | Authentication : `AuthenticationMode` |

Authentication to be used connecting to the OPC UA Server.

Possible values:


Default: UsernamePassword
Example: AuthenticationMode.UsernamePassword

| | Username : `String` |

Username for the authentication.


Default: -
Example: user

| | đź—ťPassword : `String` |

Password for the authentication.


Default: -
Example: pass

| | CertificatePath : `String` |

Path to the certificate to be used to authenticate to OPC UA Server.


Default: -
Example: C:\path\to\certificate

| | đź—ťCertificatePassword : `String` |

Password for the certificate file.


Default: -
Example: Password

| | PrivateKeyPath : `String` |

Path to the private key. Used forr certificate authentication if .der or .crt typed certifications are being used.


Default: -
Example: C:\path\to\privatekey

| | ConnectionTimeout : `Int32` |

Connection timeout in seconds.


Default: 10
Example: 10

| | SessionTimeout : `Int32` |

Session timeout in seconds.


Default: 60
Example: 60

| | SecurityMode : `OpcMessageSecurityMode` |

Defines the OPC UA message security level applied to communication between client and server.

Controls whether messages are sent without security, digitally signed for integrity,

or both signed and encrypted for full confidentiality and protection against tampering.

Possible values:

This mode provides no confidentiality or integrity protection and should only be used in trusted environments such as development or isolated networks.

The content is not encrypted, meaning it can still be read in transit.

This mode protects against tampering but does not provide confidentiality.

This provides full confidentiality, integrity, and authentication of OPC UA communication.

This is the recommended mode for production and untrusted networks.


Default: None
Example: OpcMessageSecurityMode.None

| | ApplicationCertificatePath : `String` |

Optional path to a PFX/PKCS#12 file to use as the client application certificate

for establishing a secure channel. When left empty a temporary self-signed certificate

is generated for the duration of the task and discarded afterwards.

Requires ApplicationCertificatePassword if the PFX is password protected.


Default: -
Example: C:\path\to\cert

| | đź—ťApplicationCertificatePassword : `String` |

Password for the PFX file specified in ApplicationCertificatePath.

Leave empty if the certificate has no password.


Default: -
Example: passphrase

| | SecurityPolicy : `OpcSecurityPolicy` |

Defines the cryptographic algorithm set used for securing OPC UA communication.

Includes encryption algorithms, hashing functions, and key exchange mechanisms.

The selected policy must be supported by the server endpoint and compatible with the chosen SecurityMode.

Possible values:

Communication is unencrypted and unsigned.

This should only be used in development or fully trusted environments.

Widely supported by industrial OPC UA servers and older PLC implementations.

Provides strong security and is widely used in current OPC UA implementations.

Designed for environments requiring maximum cryptographic strength and compliance.


Default: None
Example: OpcSecurityPolicy.None

| | {% endtab %} | | {% tab title="Options" %} | Name | Description | | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ApplicationName : `String` |

Application name used when connecting to the OPC UA Server.


Default: Frends.OpcUa.Client
Example: Frends.OpcUa.Client

| | PkiRootPath : `String` |

The root directory path where the OPC UA client PKI store is located.

The SDK will create the following subdirectories automatically:

own — stores the auto-generated client application certificatetrusted — stores trusted server certificatesrejected — stores rejected server certificates

On first connect the SDK generates a self-signed application certificate and saves it

under {PkiRootPath}/own, which is then reused on subsequent runs.

Only applicable when OpcMessageSecurityMode is anything other than None.


Default: -
Example: ./pki

| | ThrowErrorOnFailure : `Boolean` |

Whether to throw an error on failure.


Default: True
Example: true

| | ErrorMessageOnFailure : `String` |

Overrides the error message on failure.


Default: -
Example: Custom error message

| | {% endtab %} | | | {% endtabs %} | | ## Task Result | Name | Description | | ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | Success : `Boolean` |

Indicates whether the read operation was successful.
Example: true

| | NodeValues : `Object` |

JSON array of node read results. Each element contains NodeId, Value, DataType, StatusCode, and SourceTimestamp.
Example: { }

| | Error : `Error` |

Error message if the operation failed.
Example: object { string Message, Exception AdditionalInfo }

| | Error.Message : `String` |

Summary of the error.
Example: Unable to join strings.

| | Error.AdditionalInfo : `Exception` |

Additional information about the error.
Example: object { Exception AdditionalInfo }

| ## Task Changelog Changelog for Task Frends.Opcua.Read. ### \[1.1.0] - 2026-07-23 #### Fixed * Updated copyright information to comply with Frends platform standards. ### \[1.0.0] - 2026-05-18 #### Added * Initial implementation --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.frends.com/tasks/tasks/opcua/read.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.