NodeOPCUA API Documentation
    Preparing search index...

    Interface OPCUAServerEndpointOptions

    interface OPCUAServerEndpointOptions {
        advertisedEndpoints?: AdvertisedEndpoint | AdvertisedEndpoint[];
        allowAnonymous?: boolean;
        alternateHostname?: string | string[];
        disableDiscovery?: boolean;
        host?: string;
        hostname?: string;
        port?: number;
        securityModes?: MessageSecurityMode[];
        securityPolicies?: SecurityPolicy[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    advertisedEndpoints? allowAnonymous? alternateHostname? disableDiscovery? host? hostname? port? securityModes? securityPolicies?

    Properties

    advertisedEndpoints?: AdvertisedEndpoint | AdvertisedEndpoint[]

    Additional endpoint URL(s) to advertise.

    Use when the server is behind Docker port-mapping, a reverse proxy, or a NAT gateway. Each URL is parsed to extract hostname and port. Each entry can be a plain URL string (inherits all security settings from the main endpoint) or an AdvertisedEndpointConfig object with per-URL overrides. The server still listens on port.

    "opc.tcp://localhost:48481"

    ["opc.tcp://localhost:48481", { url: "opc.tcp://public:4840", securityModes: [MessageSecurityMode.SignAndEncrypt] }]
    allowAnonymous?: boolean

    tells if the server default endpoints should allow anonymous connection.

    true
    alternateHostname?: string | string[]

    alternate hostname or IP to use

    disableDiscovery?: boolean

    true, if discovery service on secure channel shall be disabled

    host?: string

    Host IP address or hostname where the TCP server listens for connections. If omitted, defaults to listening on all network interfaces:

    • Unspecified IPv6 address (::) if IPv6 is available,
    • Unspecified IPv4 address (0.0.0.0) otherwise. Use this to bind the server to a specific interface or IP.
    hostname?: string

    the primary hostname of the endpoint.

    getFullyQualifiedDomainName()
    port?: number

    the TCP port to listen to.

    26543
    securityModes?: MessageSecurityMode[]

    the possible security mode that the server will expose

    [MessageSecurityMode.None, MessageSecurityMode.Sign, MessageSecurityMode.SignAndEncrypt]
    securityPolicies?: SecurityPolicy[]

    the possible security policies that the server will expose

    [SecurityPolicy.None, SecurityPolicy.Basic128Rsa15, SecurityPolicy.Basic256Sha256, SecurityPolicy.Aes128_Sha256_RsaOaep, SecurityPolicy.Aes256_Sha256_RsaPss  ]

    Settings

    Member Visibility

    On This Page

    Properties