5 Service Sets ToC Previous Next

5.4 Discovery Service Set ToC Previous Next

5.4.2 FindServers ToC Previous Next

5.4.2.1 Description ToC

This Service returns the Servers known to a Server or Discovery Server. The behaviour of Discovery Servers is described in detail in OPC 10000-12.

The Client may reduce the number of results returned by specifying filter criteria. A Discovery Server returns an empty list if no Servers match the criteria specified by the client. The filter criteria supported by this Service are described in 5.4.2.2.

Every Server shall provide a DiscoveryEndpoint that supports this Service. The Server shall always return a record that describes itself, however in some cases more than one record may be returned. Gateway Servers shall return a record for each Server that they provide access to plus (optionally) a record that allows the Gateway Server to be accessed as an ordinary OPC UA Server. Non-transparent redundant Servers shall provide a record for each Server in the Redundant Server Set.

Every Server shall have a globally unique identifier called the ServerUri. This identifier should be a fully qualified domain name; however, it may be a GUID or similar construct that ensures global uniqueness. The ServerUri returned by this Service shall be the same value that appears in index 0 of the ServerArray property (see OPC 10000-5). The ServerUri is returned as the applicationUri field in the ApplicationDescription (see 7.1)

Every Server shall also have a human readable identifier called the ServerName which is not necessarily globally unique. This identifier may be available in multiple locales.

A Server may have multiple HostNames. For this reason, the Client shall pass the URL it used to connect to the Endpoint to this Service. The implementation of this Service shall use this information to return responses that are accessible to the Client via the provided URL.

This Service shall not require message security but it may require transport layer security.

Some Servers may be accessed via a Gateway Server and shall have a value specified for gatewayServerUri in their ApplicationDescription (see 7.1). The discoveryUrls provided in ApplicationDescription shall belong to the Gateway Server. Some Discovery Servers may return multiple records for the same Server if that Server can be accessed via multiple paths.

This Service can be used without security and it is therefore vulnerable to Denial of Service (DOS) attacks. A Server should minimize the amount of processing required to send the response for this Service. This can be achieved by preparing the result in advance. The Server should also add a short delay before starting processing of a request during high traffic conditions.

5.4.2.2 Parameters ToC

Table 3 defines the parameters for the Service.

Table 3 – FindServers Service Parameters

Name Type Description
Request    
   requestHeader RequestHeader Common request parameters. The authenticationToken is always null. The authenticationToken shall be ignored if it is provided.
The type RequestHeader is defined in 7.28.
   endpointUrl String The network address that the Client used to access the DiscoveryEndpoint.
The Server uses this information for diagnostics and to determine what URLs to return in the response.
The Server should return a suitable default URL if it does not recognize the HostName in the URL.
   localeIds [] LocaleId List of locales to use.
The Server should return the applicationName in the ApplicationDescription defined in 7.1 using one of locales specified. If the Server supports more than one of the requested locales then the Server shall use the locale that appears first in this list. If the Server does not support any of the requested locales it chooses an appropriate default locale.
The Server chooses an appropriate default locale if this list is empty.
   serverUris [] String List of servers to return.
All known servers are returned if the list is empty.
A serverUri matches the applicationUri from the ApplicationDescription defined in 7.1.
     
Response    
   responseHeader ResponseHeader Common response parameters.
The ResponseHeader type is defined in 7.29.
   servers [] ApplicationDescription List of Servers that meet criteria specified in the request.
This list is empty if no servers meet the criteria.
The ApplicationDescription type is defined in 7.1.

5.4.2.3 Service results ToC

Common StatusCodes are defined in Table 177.

Previous Next