N2SVCD Configuration - PIApp

PI Application Configuration

The N2SVCD PI Application is a protocol gateway application which can perform client requests using the Man-Machine Language (MML) or Simple Object Access Protocol (SOAP) protocols used by the Oracle OCNCC "Provisioning Interface" service component running on an Oracle SMF node. The N-Squared Tester Application requires a PI Application instance to be installed in order to execute PI tests.

The following configuration is used to create a PI Application instance to act as a protocol gateway to an Oracle OCNCC Provisioning Interface. A single PI Application instance will maintain a pool of connections to a single PI Server Address. If you need to connect to more than one remote PI Server Address, or use more than one access protocol, you must configure multiple PI Application instances (each with unique names).

<?xml version="1.0" encoding="utf-8"?>
<n2svcd>
  ...
  <applications>
    ...
    <application name="PI-SMF01" module="PIApp">
      <include><lib>../apps/pi/lib</lib></include>
      <parameters>
        <parameter name="remote_host" value="10.42.2.154"/>
        <parameter name="remote_port" value="4999"/>
        <parameter name="username" value="admin"/>
        <parameter name="password" value="admin"/>
        <parameter name="pool" value="3"/>
      </parameters>
    </application>
    ...
  </application>
  ...
</n2svcd>

The application element attributes for a PI Application instance are:


Attribute Type Description
name String [Required] A unique name for this application instance.
module String [Required] PIApp
include.lib String [Required] ../apps/pi/lib
parameters Array [Required] Array of name = value Parameters for this Application instance.
.protocol String Determines if the client should use MML (mml) or SOAP (soap) to connect to the NCC PI Server.
(Default = mml).
.remote_host String [Required] IPv4 Host Name or A.B.C.D IPv4 Address for PI Server.
.remote_port Integer [Required] IPv4 Port Number for PI Server.
.username String [Required] Username to present to OCNCC PI as credentials.
.password String [Required] Password to present to OCNCC PI as credentials.
.ssl Integer Should this PI SOAP application use SSL/TLS for its sever connections.
1 (Use SSL/https) or 0 (No-SSL, use http).
(Default = 0).
.ssl.SSL_verify_mode Integer Should this PI SOAP application verify the Server Peer's certificate?
1 (Verify Server's Certificate) or 0 (Do not verify Server's Certificate).
(Default = 1).
.ssl.SSL_ca_file String Use a Certificate Authority contained in the indicated file.
(Default = Use system default Certificate Authorities).
.ssl.SSL_ca_path String Use all Certificate Authority files contained in the indicated directory.
Multiple directories may be delimited by the : character.
(Default = Use system default Certificate Authorities).
.pool Integer Number of simultaneous TCP client connections we open to the PI Server.
(Default = 2).
.backlog_timeout Integer Number of seconds to wait for a free connection before abandoning the request.
(Default = 10 seconds).
.server_timeout Integer Number of seconds to wait on a submitted request before abandoning the request.
(Default = 20 seconds).
.reconnect_interval Integer Time in seconds between attempts to re-connect a failed PI connection.
(Default = 5 seconds).
.ping_interval Integer Time in seconds between 'ping' to check connection on an inactive PI connection.
A ping_interval of zero will disable ping connection checks.
Only MML connections will perform ping connection checks.
(Default = 300 seconds).

Note: The PI Server allows only one outstanding request per client connection.

Note: All SOAP requests are performed using "Implicit Login". This means that the NCC PI Server must be configured with implicitLoginsSupported = true and with validateAuthStrings = false. These are the default settings for the NCC SOAP Server.

When using MML, the PI Application will open [size of connection pool] permanent connections to the NCC Server. Each connection will be logged-in, and the connection will be used for multiple MML requests (although with only one outstanding request per connection at any time).

When using SOAP, the PI Application will maintain a pool of [size of connection pool] re-usable connections. When a request is to be sent, an unusued connection will be selected, and connected to the NCC Server. The connection will be used for one request only, at the end of which it will be disconnected and returned to the free pool.