CorvilNet

Overview Copied

The CorvilNet integration enables Geneos to connect with the CorvilNet Engine (CNE). This integration makes available the network monitoring data from the CorvilNet Engine to Geneos. This integration is performed through the API plugin.

The set up, the integration, and its associated API plugin comprise the CorvilNet plugin (CNPI).

When you set up the CNPI for the first time, it produces three basic dataviews:

• cnpiConfig — shows the general information and status of your CNPI.
• qosAlerts — shows any outstanding quality-of-service alerts.
• systemAlerts — shows any outstanding system alerts.

The CorvilNet monitoring statistics views appear when you configure the respective configuration (.cfg) files on the API sampler. These views are the main feature of the CorvilNet monitoring integration, as these show the monitoring statistics coming from the CNE:

• getSummary — shows a summary of the CorvilNet monitoring statistics.

• getStats — shows historical statistics as monitored by the CNE.

• getLiveStats — shows live statistics as monitored by the CNE.

• getAnalytics — shows analytics statistics for configured measurement-points as monitored by the CNE over a selected reporting period.

• getMessageCsv — shows per-message breach detail as monitored by the CNE for a single measurement-point, using incremental polls over the configured update interval.

• getLensData — shows Lens tag-aggregated statistics (for example, latency and bandwidth) grouped by configured Lens tag types rather than by measurement-point.

  Note

  • The getAnalytics view is available in geneos-cnpi 2.1.0 and later.
  • The getMessageCsv and getLensData views are available in geneos-cnpi 2.2.0 and later.

If you are using the Latency Management Centre (LMC) to monitor your CNE, then your integration includes three additional views:

• trapFODConfig — shows the configuration details of the trap fan-out daemon (trapFOD), including errors encountered when you run the trapFOD.
• fodCNEStatus — shows the status of the trap-forwarding process for each known CNE.
• fodCNPIStatus — shows the status of the trap-forwarding process for each known CNPI instance.

The CNPI receives monitoring statistics from the CNE through the Corvil API. The CNE also sends system event information through the Simple Network Management Protocol (SNMP).

This guide discusses the steps to set up the CorvilNet plugin from its source integration files. Once the integration is set up, the dataviews become available through the API plugin.

Information related to setting up and administering the CNE or LMC is out of scope of this guide.

Intended audience Copied

This guide is directed toward experienced Geneos users who want to set up an integration between Geneos and the CorvilNet Engine (CNE). If the organisation uses the Corvil Latency Management Centre (LMC) to manage multiple instances of the CNE, then there are additional steps in the integration.

The CorvilNet monitoring integration requires a Linux machine. As a user, you should be familiar with general system administration on this platform.

Prerequisites Copied

The following requirements must be met before the installation and setup of the template:

• A Linux machine where the CNPI and, if applicable, the trapFOD can run.
• The machine where the CNPI runs must be able to communicate with the CNE via HTTP or SNMP.
• We recommend that you set up the integration on the same machine as the Netprobe. Otherwise, ensure that the machines can communicate via SNMP.
• This requires an additional licence to use. Please contact your ITRS Account Manager for more information.

CorvilNet Engine credentials Copied

When you configure the CorvilNet monitoring integration, you will need the following information from your CNE:

• Address or hostname
• Web services interface port number
• Web services interface username and password

If you are using SNMP to connect the CNE to the CNPI, then you will need the following:

• SNMP port number
• SNMP community string

Connection structure Copied

Depending on your organisation, your CorvilNet monitoring integration could look like one of the following:

Connecting to a CorvilNet Engine Copied

Each instance of the CNPI communicates with a partner CNE. If you are monitoring multiple instances of the CNE, then you must set up a CNPI instance for each.

For each CNPI and partner CNE combination, you must configure the CNE with the network address or hostname of the machine where the CNPI is running, as well as the same port.

Supported versions of CNE API Copied

The web service of CNE API has two versions, and their support depends on the geneos-cnpi version.

• geneos-cnpi 1.4.0 and older supports the CNE API version 1.
• geneos-cnpi 2.0.0 and later supports the CNE API version 2.

Connecting to a Latency Management Centre Copied

If you are using the LMC, then the CNE and CNPI communicate through SNMP traps. In this integration, the SNMP traps are routed and forwarded by the trapFOD.

Each trapFOD communicates with an LMC. If you are monitoring multiple instances of the LMC, then you must set up a trapFOD instance for each.

Integrate CorvilNet Engine into Geneos Copied

The CorvilNet integration involves the following tasks:

1. Download the integration files.
2. Set up the API sampler.
3. Associate the API plugin with a managed entity.
4. Set up the CorvilNet start-up script.
5. Run the CorvilNet start-up script.

Download the integration files Copied

1. On the Downloads page, download the CorvilNet integration files.
2. Save the files on the Linux machine where plan to run the CorvilNet integration.

The integration files include the following sub-folders:

• examples — contains the configuration templates and start-up script you need to set up the integration.
• Linux_x86_64 — contains the source files that run the CorvilNet integration.

Set up the API sampler Copied

1. On the Gateway Setup Editor, create a new sampler by right-clicking the Samplers folder.
2. Enter a name for this sampler. As a default, enter the name CNE in the Name field.
3. On the drop-down list under the Plugin field, select api.
4. Click Save current document to apply your changes.

Associate the API plugin with a managed entity Copied

1. On the Gateway Setup Editor, create a new managed entity by right-clicking the Managed entities folder.
2. Enter a name for this managed entity. As a default, enter the name CN in the Name field.
3. In the Options field, select the probe on which you want the sampler to run.
4. Under the Sampler field, click Add new.
5. In the text field under Ref, type the name of the API sampler you had created. By default, this is CNE.
6. Click Save current document to apply your changes.

Set up the CorvilNet start-up script Copied

1. From the CorvilNet integration files you downloaded, go to the examples folder and locate the file named start_cnpi.
2. Open start_cnpi in a text editor.
3. Replace the values in brackets with the respective details from your system. For more information, see the CorvilNet plugin start-up script variables.

Run the CorvilNet start-up script Copied

1. Open the Terminal.
2. Enter the following command:

bash$ chmod u+x start_cnpi

Success

After you run the integration script, the basic dataviews appear under the managed entity that you configured for CorvilNet. For more information on the basic dataviews, see the Default metrics and dataviews.

If you set the start script to have the --verbose setting, then you will see some initial information in the log file. Otherwise, the log file is empty.

Encryption utility Copied

The encryption utility, cnpi_crypt, is included in the integration files. Run this utility to encrypt your CNE password:

1. Open the Terminal.
2. Navigate to the Linux_x86_64 folder from the CorvilNet integration files.
3. Enter the following command:

.\cnpi-crypt [your CNE password]

Success

When you enter this command, the utility encrypts the password and displays its encrypted string on the Terminal.

7. Copy the encrypted string and use this for the {EncryptedPassword} variable in the start-up script.

Shutdown script Copied

If you want to shut down the CNPI, follow these steps:

1. Locate the PID file in the {LogLocation} you specified in CorvilNet start-up script variables.
2. Open the Terminal.
3. Enter the following command, specifying the {LogLocation} and the PID file on your system. For example:

bash$ kill $(cat /home/user/log/geneos-cnpi.pid )

Success

This command kills the process associated with the CNPI.

Configure CorvilNet Engine statistics view Copied

Data from the CorvilNet Engine can be processed and displayed by Geneos to a dataview with rows for each measurement-point and columns for statistical values.

Prerequisites Copied

The location of each configuration file must be added to the Parameters section of the API sampler you created in Set up the API sampler. The configuration filename follows the CFGFILEnn format, where nn is a two-digit number. The filenames do not have to be added in order and succession.

Note

The default value of nn is 10. If more configuration files are required, then the maximum value for nn may be changed using --max-cfg-files=number. For more information, see geneos-cnpi command synopsis.

Customize configuration file header Copied

Example configuration file header Copied

# Once per minute, no alerts
GENEOS-CNPI
INTERVAL 1 minute
ALERTS no
NODATA unchanged

Customize summary configuration file Copied

Example summary view configuration file Copied

# Daily summary statistics for London updated hourly
GENEOS-CNPI
INTERVAL 1 hour
ALERTS no
NODATA unchanged

getSummary
NAME summary24HoursChannels
PERIOD 24-hours
FILTER channel*

Customize stats configuration file Copied

The top-* range statistics Copied

The top-* range statistics only supply time-series graph data. These data do not naturally fit into the Geneos table structure, unlike the other 3-dimensional statistics. To display these statistics, Geneos creates a unique row key for each measurement-point or key combination. Additionally, measurement-point and key columns are also created in the dataview so that data elements can still be identified.

This conversion process has the following implications for views including the top-* statistics:

• Exactly one statistic must be specified per view. Additional statistics, whether pre-defined or configurable, cannot be supported.
• The ROWKEY url|ref view option behaves differently. Specifying the non-default ref option simply removes the measurementPoint column. The addition of custom-measurement-point names is supported as normal.
• The CNE provides top-* statistics information in fixed units. Specifying the units for pre-defined statistics is not supported.

Example historical statistics view configuration files Copied

• 15-minute latency statistics (all), every five minutes:

GENEOS-CNPI
INTERVAL 1 minute
ALERTS no
NODATA blank

getStats
NAME latency15Minutes
PERIOD 15 minutes

MP-MECH pnqm

STATS-GROUP pnqm

• LSE 1-hour latency statistics, jitter plus 99.99%, four configurable statistics, market hours, updated every five minutes, display names included:

GENEOS-CNPI
INTERVAL 1 minute
ALERTS no
NODATA blank

getStats
NAME LSE1Hour
DISPLAYNAMES yes
PERIOD BUSINESS-DAY 08:00 16:32

MP-PCRE "rt-class.*LSE-Infolect.*"

STATS-LIST e2e-latency, e2e-loss
STATS-LIST 99.99% e2e-jitter
CFG-STATS-LIST Orders, Fills, "Cancelled Orders", "Rejected Orders"

• Top conversations:

GENEOS-CNPI
INTERVAL 1 minute
ALERTS no
NODATA blank

getStats
NAME topConversations
PERIOD 15 minutes

MP-ALL

STATS-LIST top-conversations

Customize live stats configuration file Copied

Example live statistics view configuration files Copied

• Live latency statistics (all), updated once per minute, display names included:

GENEOS-CNPI
INTERVAL 1 minute
ALERTS yes
NODATA blank

getLiveStats

VIEW
  NAME latencyNow
  DISPLAYNAMES yes
  MP-ALL
  STATS-GROUP pnqm

• Venue latency statistics, jitter plus variable RP, updated once per minute:

GENEOS-CNPI
INTERVAL 1 minute
ALERTS yes
NODATA blank

getLiveStats

VIEW
  NAME lseNow
  MP-PCRE "rt-class.*LSE-Infolect.*"
  STATS-LIST e2e-latency, e2e-loss
  STATS-LIST 99.99% e2e-jitter

VIEW
  NAME chicagoNow
  MP-PCRE "rt-class.*Chicago.*"
  STATS-LIST e2e-latency, e2e-loss
  STATS-LIST 99.8% e2e-jitter

VIEW
  NAME frankfurtNow
  MP-PCRE "rt-class.*Frankfurt.*"
  STATS-LIST e2e-latency, e2e-loss
  STATS-LIST 98% e2e-jitter

VIEW
  NAME newJerseyNow
  MP-PCRE "rt-class.*NewJersey.*"
  STATS-LIST e2e-latency, e2e-loss
  STATS-LIST 99.8% e2e-jitter

VIEW
  NAME eurexNow
  MP-PCRE "rt-class.*Eurex.*"
  STATS-LIST e2e-latency, e2e-loss
  STATS-LIST 99.8% e2e-jitter

VIEW
  NAME euronextNow
  MP-PCRE "rt-class.*Euronext.*"
  STATS-LIST e2e-latency, e2e-loss
  STATS-LIST 99.8% e2e-jitter

Customize analytics configuration file Copied

Note

This feature requires geneos-cnpi 2.1.0 or later.

Example analytics view configuration file Copied

Analytics for a single measurement-point, updated every five minutes, with display names enabled:

GENEOS-CNPI
INTERVAL 5 minutes
ALERTS no
NODATA blank

getAnalytics
NAME coreAnalytics
DISPLAYNAMES yes
PERIOD 1-hour
POINTS 60

MP-LIST
  MP rt-class/CUST_AlgoSpeed//London_CNE/CustomerGateway//class-default

STATS-LIST tcp-fin-packet-count

Customize message CSV configuration file Copied

Note

This feature requires geneos-cnpi 2.2.0 or later.

Example message CSV view configuration file Copied

Message breach detail for a single measurement-point, updated every five minutes, with a minimum latency filter and a row cap:

GENEOS-CNPI
INTERVAL 5 minutes
ALERTS no
NODATA unchanged

getMessageCsv
NAME highLatencyOuch
MEASUREMENT-POINT channel///London_CNE//OUCH-RTT
MIN-LATENCY-US 1000
MAX-ROWS 500
COLUMN-LIST time,ts_ns,CorvilOrderId,PNQM Latency (ms),Msg Type
ROWKEY-COLUMN ts_ns

For message CSV views, the configured INTERVAL also sets the first-poll look-back window. After the plugin starts, the first poll requests messages from now - INTERVAL up to now. Each later successful poll continues from the end of the previous poll. A failed poll does not advance the watermark.

Values supplied in MEASUREMENT-POINT, COLUMN-LIST, and ROWKEY-COLUMN are XML-escaped before they are sent to the CNE, so you can include characters such as &, <, >, ", and ' verbatim in the configuration file.

Customize Lens data configuration file Copied

Note

This feature requires geneos-cnpi 2.2.0 or later.

Example Lens data view configuration file Copied

Lens latency, bandwidth, and round-trip time by protocol and broker, updated every five minutes:

GENEOS-CNPI
INTERVAL 5 minutes
ALERTS no
NODATA unchanged

getLensData
NAME lensLatencyBandwidth
OVERALL yes
PERIOD 24-hours
LENS-FILTER tag Protocol is OUCH
GROUP-BY Protocol
GROUP-BY Broker
LENS-STATS-LIST latency max mean, packet-bitrate, tcp-roundtrip-time max mean

Lens data views aggregate statistics by Lens tag types rather than by measurement-point. They do not use MP-* lines. Rows are keyed by the tagPath column, a slash-separated path built from the configured GROUP-BY tag values (and session names when session breakdown is enabled).

Values supplied in LENS-FILTER (tag type, operator, and filter values) and in each GROUP-BY tag type are XML-escaped before they are sent to the CNE, so you can include characters such as &, <, >, ", and ' verbatim in the configuration file when they appear in those tokens.

View options Copied

Several view options are supported on how a view is constructed and displayed. Options from this list may be included in any order. If a particular option is repeated, then any yes will take precedence over all no values.

Note

For getMessageCsv and getLensData views, only DISPLAYNAMES and ROWKEY from this table apply where relevant. The WITH-VALUE, CFG-WITH-VALUE, and CFG_WITH_SPACE options apply only to historical, live, and analytics statistics views.

Specify measurement-points and statistics Copied

Specify measurement-points Copied

The Geneos CNPI reads data on the configured measurement-points from CNE and uses this data as the basis for constructing the set of measurement-points. The constructed measurement-points are used in historical statistics and live statistics views.

The measurement-point data is only read during initialisation. If the measurement-point configuration in CNE is changed, then you need to restart the plugin for the changes to reflect.

Note

Measurement-points associated with offline channels are not supported by the CNE in the live statistics view. Such measurement-points are identified by Geneos CNPI during initialisation and automatically removed from live statistics views. The full set of measurement-points that will be automatically removed for this reason is listed in a --verbose log output.

The plugin supports the following ways on how the set of measurement-points configured in CNE is displayed in a dataview. One method may be used for each set of measurement-points to be specified.

Note

The getMessageCsv views use a single required MEASUREMENT-POINT line instead of the MP-* selectors in this table. The getLensData views do not select measurement-points. They aggregate by Lens tags.

Name measurement-points Copied

By default, measurement-points are named only by the technical name used as the key to view rows, such as rt-class/FIX-SERVERS//London_CNE/FIX-CLIENTS/FIX-RTT/class-default. Such names make the construction of a meaningful dashboard a challenge. There are two options for providing user-friendly measurement-point names:

• display-names, which are configured in CNE and read by Geneos CNPI during initialisation; and
• measurement-point aliases, which are configured in the view configuration file.

When defining aliases for measurement-points note the following:

• an alias for a measurement-point can be defined once per view;
• all measurement-points in a view do not need to be aliased; and
• all aliased measurement-points do not need to be present in the view.

Notes:

• The measurement-points present in views, where a matching alias is not configured will be identifiable by the measurement-point reference only.
• It is recommended to use a --verbose log for configurations relying on measurement-point aliases as the name, reference, and alias for all measurement-points to identify anonymous rows.

The following are the mechanisms by which aliases can be defined.

Examples Copied

The following are examples of parts of configuration files selecting measurement-points:

MP-MECH pnqm "rt-class.*"

MP-CFG-STATS "Cancels/Orders", PartialFills, "Filled Vol", "Fill Rate"

MP-PCRE "rt-class.*Client.*"

MP-PCRE "rt-class.*"
MP-ALIASES-FILE "/home/geneos/cnpi/amsterdam_mp.aliases"

# Aliases London->Amsterdam
rt-class//London-CNE/Amsterdam_CNE/EU-Amsterdam//Voice “London->Amsterdam (Voice)”
rt-class//London-CNE/Amsterdam_CNE/EU-Amsterdam//Management “London->Amsterdam (Management)”
rt-class//London-CNE/Amsterdam_CNE/EU-Amsterdam//Citrix “London->Amsterdam (Citrix)”

# Aliases Amsterdam->London
rt-class/EU-Amsterdam/Amsterdam_CNE/London-CNE///Voice “Amsterdam->London (Voice)”
rt-class/EU-Amsterdam/Amsterdam_CNE/London-CNE///Management “Amsterdam->London (Management)”
rt-class/EU-Amsterdam/Amsterdam_CNE/London-CNE///Citrix “Amsterdam->London (Citrix)"

Specify pre-defined statistics Copied

The statistics to be displayed in the dataview can be configured using the following methods. These methods can be used at the same time in a configuration file.

Note

These methods apply to the getStats, getLiveStats, and getAnalytics views. The getMessageCsv views use COLUMN-LIST instead. The getLensData views use LENS-STATS-LIST instead.

Specify the units of pre-defined statistics Copied

By default, many statistics are supplied by the CNE with accompanying statUnits and statFactor columns such that dividing the contents of a statValue cell by the contents of the statFactor cell will give stat in the unit shown in the statUnit cell. For example, should e2eLatencyUnit contain ms, e2eLatencyFactor contain 1000000, and e2eLatencyMin contain 10317000, then the minimum latency for that row was measured as 10.317ms.

Geneos CNPI can perform the unit conversion of the statistics if you wish to use a different unit. This is configured using optional parameters to STATS-GROUP and STATS-LIST in the getStats and getLiveStats configuration files.

For STATS-GROUP elements, the parameters will control the presentation of all statistics in the specified group.

For STATS-LIST elements, each named statistic in the list will support parameters to control the display of that statistic’s fields.

The optional parameters are as follows:

• RAW — causes Geneos CNPI to ignore any statFactor or statUnit columns received. Only the stat value columns are displayed, instead. This is a minimalist, low-load display for users, who wish to use their knowledge of the actual units provided by CNE and Geneos tools to create their display.
• CNEUNITS [ DECIMAL places ] — causes Geneos CNPI to convert the stat value columns following the statFactor column provided by the CNE. If the optional [DECIMAL places]is provided, then the converted values will have a maximum of places decimal places. Otherwise, there will be no decimals. The statFactor column is not displayed and the statUnit column is displayed.
• FACTOR factor [ DECIMALS places ] — causes the Geneos CNPI to ignore any statFactor and statUnit columns received. The stat value columns are divided by the specified factor. Only factors that are a power of 10 are supported. If the optional [DECIMAL places]is provided, then the converted values will have a maximum of places decimal places. Otherwise, there will be no decimals.

Examples Copied

The following are examples of parts of configuration files selecting statistics:

STATS-LIST 97%,98%,99% e2e-latency

STATS-LIST
97%,98%,99%
e2e-latency

STATS-GROUP 99%, 99.5% pnqm
STATS-GROUP 99%, 99.5% tcp

STATS-GROUP 95% pnqm CNEUNITS DECIMALS 3

STATS-LIST 98%
e2e-latency FACTOR 1000000 DECIMALS 4,
e2e-jitter FACTOR 1000000

Specify configurable statistics Copied

The set of configurable statistics names is read from the CNE during initialisation. This set is used to validate configuration files.

Note

If a request is received for a configurable statistic with a name that is not known to the plugin, then the configuration file is rejected.

Note

Configurable statistics in this section apply only to the getStats, getLiveStats, and getAnalytics views. The getMessageCsv and getLensData views do not use CFG-STATS-LIST.

The units of display for configurable statistics are selected in the same way as for the pre-defined statistics using the RAW, CNEUNITS, FACTOR, and DECIMALS keywords. For more information, see Specify the units of pre-defined statistics.

Examples Copied

The following are examples of parts of configuration files selecting configurable statistics:

CFG-STATS-LIST 90%, 95% "Cancels/Orders", PartialFills, "Filled Vol", "Fill Rate"

CFG-STATS-LIST
"Cancels/Orders" CNEUNITS,
PartialFills CNEUNITS,
"Filled Vol" CNEUNITS,
"Fill Rate" CNEUNITS

Configure Latency Management Centre Copied

If you are using the CNE through the LMC, then there are additional steps for you to perform:

1. Set up the trapFOD start-up script.
2. Run the trapfod start-up script.
3. Set the FOD parameters in the sampler.

Set up the trapFOD start-up script Copied

1. From the CorvilNet integration files you downloaded, go to the examples folder and locate the file named start_fod.
2. Open start_fod in a text editor.
3. Replace the values in brackets with the respective details from your system. For more information, see trapFOD start-up script variables.

Run the trapfod start-up script Copied

1. Open the Terminal.
2. Enter the following command:

bash$ chmod u+x fod_cnpi

Success

After you run the integration script, the trapFOD dataviews appear under the managed entity that you configured for CorvilNet. For more information on the dataviews, see the trapFOD metrics and dataviews.

If you set the start script to have the --verbose setting, then you will see some initial information in the log file. Otherwise, the log file is empty.

Set the FOD parameters in the sampler Copied

1. On the Gateway Setup Editor, open the sampler you set up in Set up the API sampler.
2. In the Basic tab, add the following parameters:

• FOD_HOSTNAME — hostname of the trapFOD.
• FOD_PORT — network port of the trapFOD.

  Success

  After you set the FOD parameters, the API sampler begins to interact with the trapFOD.

Default metrics and dataviews Copied

cnpiConfig Copied

qosAlerts and systemAlerts Copied

The qosAlerts and systemAlerts views have the same metrics. However, they report different events:

• qosAlerts — shows any outstanding quality-of-service alerts.
• systemAlerts — shows any outstanding system alerts.

CorvilNet API metrics and dataviews Copied

The views in this section show CNE network monitoring statistics. The CNPI passes these statistics to Geneos.

These views do not appear by default and require you to configure the API sampler you set up for the CNPI. For more information, see Configure CorvilNet Engine statistics view.

Note

The field names in this section are controlled by Corvil. For more information, see the CorvilNet API Reference Guide. The fields listed there are as they appear in Corvil API version 6.1.

getSummary view Copied

This view displays a pre-defined set of statistics summarized over one time period selected from a set of fixed time periods.

getStats view Copied

This view displays historical statistics distribution containing the minimum, mean, and maximum values for a configured set of named statistics over variable time periods.

getLiveStats view Copied

This view displays the live values for a configured set of named statistics.

getAnalytics view Copied

This view displays analytics statistics for a configured set of measurement-points over a selected reporting period.

getMessageCsv view Copied

This view displays per-message breach detail for a single measurement-point. Each row is one message from the CSV attachment returned by the CNE through the statsMTOM-v2 API.

getLensData view Copied

This view displays Lens tag-aggregated statistics for a configured reporting period. Rows are grouped by Lens tag types rather than by measurement-point.

trapfod metrics and dataviews Copied

The trapFOD views pertain to the status of the trap fan-out daemon (trapFOD), which acts as the single routing point for SNMP traps in integrations where the CNPI connects to the LMC instead of a single CNE.

trapFODConfig view Copied

fodCNEStatus view Copied

Note

One row is displayed per known CNE. The LMC discovers CNEs as requested by the CNPI. If a known CNE forwards data to the LMC without an associated request from the CNPI, then the information appears as a blank row and indicates an error condition.

fodCNPIStatus view Copied

Appendix Copied

CorvilNet plugin start-up script variables Copied

The start_cnpi file is a default template for the start-up script, which sets up the CorvilNet integration. You need to replace the bracketed fields with the requisite CorvilNet Engine credentials.

Note

Remove the brackets ({}) when adding you system credentials into the start script.

#!/bin/bash
# Template start-up script for the Geneos CorvilNet plugin, geneos-cnpi.
# See the plug-in manual for a further explanation of this script.

# The location where the plug-in media was unpacked
export CNPI_UNPACK={UnpackLocation}

# The name of the subdirectory containing the executable and libraries appropriate to the host environment
# (eg Linux_x86_64, SunOS, etc)
export HOST_TYPE={HostType}

# The name of the directory in the unpack location containing the version of the plug-in to be used.
export CNPI_VERSION={PlugInVersion}

# The location to which the plug-in can write log files
export LOG_DIR={LogLocation}

# The relevant Geneos components
export MANAGED_ENTITY={ManagedEntity}
export NETPROBE_HOSTNAME={LocalHost}
export NETPROBE_PORT={Port}
export SAMPLER_NAME={SamplerName}

# The relevant Corvil components
export CNE_API_HOSTNAME={APIHostname}
export CNE_API_PORT={APIPort}
export CNE_USERNAME={Username}
export CNE_ENCRYPTED_PASSWORD={EncryptedPassword}
export CNE_SNMP_PORT={SNMPPort}
export CNE_COMMUNITY={CommunityString}
export CNE_API_PROTOCOL={APIProtocol}
export CNE_API_PATH={APIPath}

# The specification of how CNE traps will be received by geneos-cnpi
export TRAP_HOSTNAME={TrapHostname}
export TRAP_PORT={TrapPort}

# START THE PLUG-IN
export CNPI_DIR=$CNPI_UNPACK/$CNPI_VERSION/$HOST_TYPE
export LD_LIBRARY_PATH=$CNPI_DIR/lib
$CNPI_DIR/geneos-cnpi $MANAGED_ENTITY $CNE_API_HOSTNAME \
    --hostname=$NETPROBE_HOSTNAME \
    --port=$NETPROBE_PORT \
    --sampler=$SAMPLER_NAME \
    --detach=$LOG_DIR \
    --pid-file=$LOG_DIR/geneos-cnpi.pid \
    --log-file=$LOG_DIR/geneos-cnpi.log \
    --license=$CNPI_UNPACK/geneos-cnpi.lic \
    --api-config=$CNPI_DIR/geneos-cnpi.cfg \
    --cne-api-port=$CNE_API_PORT \
    --cne-username=$CNE_USERNAME \
    --cne-encrypted-password=$CNE_ENCRYPTED_PASSWORD \
    --cne-snmp-port=$CNE_SNMP_PORT \
    --cne-community="$CNE_COMMUNITY" \
    --cne-protocol=$CNE_API_PROTOCOL \
    --cne-path=$CNE_API_PATH \
    --trap-hostname=$TRAP_HOSTNAME \
    --trap-port=$TRAP_PORT \
    --brief

# start_cnpi

Note

In the start script, notice the line --brief near the end of the file. You may change this to --verbose or --debug. This setting determines whether the CNPI returns brief or verbose logs and error messages.

trapFOD start-up script variables Copied

The start_fod file is a default template for the start script, which sets up the CorvilNet integration through the LMC. You need to replace the bracketed fields with the requisite CorvilNet Engine credentials.

Note

Remove the brackets ({}) when adding your system credentials into the start script.

#!/bin/bash
# Template start-up script for the Geneos CorvilNet plugin trap fan-out daemon, trapfod.
# See the plugin manual for a further explanation of this script.

# The location where the plugin media was unpacked
export FOD_UNPACK={UnpackLocation}

# The name of the subdirectory containing the executable and libraries appropriate to the host environment
# (eg Linux_x86_64, SunOS, etc)
export HOST_TYPE={HostType}

# The name of the directory in the unpack location containing the version of the plugin to be used.
export CNPI_VERSION={PlugInVersion}

# The location to which the daemon should write log files
export LOG_DIR={LogLocation}

# The relevant Geneos components
export MANAGED_ENTITY={ManagedEntity}
export NETPROBE_HOSTNAME={LocalHost}
export NETPROBE_PORT={Port}
export SAMPLER_NAME={SamplerName}

# The specification of how CNE traps will be received by trapfod
export TRAP_HOSTNAME={TrapHostname}
export TRAP_PORT={TrapPort}

# START THE DAEMON
export FOD_DIR=$FOD_UNPACK/$CNPI_VERSION/$HOST_TYPE
export LD_LIBRARY_PATH=$FOD_DIR
$FOD_DIR/trapfod $MANAGED_ENTITY \
--hostname=$NETPROBE_HOSTNAME \
--port=$NETPROBE_PORT \
--sampler=$SAMPLER_NAME \
--detach=$LOG_DIR \
--pid-file=$LOG_DIR/trapfod.pid \
--log-file=$LOG_DIR/trapfod.log \
--license=$FOD_UNPACK/geneos-cnpi.lic \
--trap-hostname=$TRAP_HOSTNAME \
--trap-port=$TRAP_PORT \
--brief

# start_cnpi

Note

In the start script, notice the line --brief near the end of the file. You may change this to --verbose or --debug. This setting determines whether theCNPI returns brief or verbose logs and error messages.

geneos-cnpi command synopsis Copied

The CorvilNet plugin receives configuration parameters and generates views through the specified Geneos managed entity managed-entity using network monitoring data from the CNE whose Web Services Interface is accessible at the hostname or IP address CNE-hostname. Then this transmits traps to this instance of geneos-cnpi.

You can refer to the geneos-cnpi daemon invocation and command line options below to configure geneos-cnpi command:

geneos-cnpi managed-entity CNE-hostname
[--version] [--help]
[ --license= filename ]
[ --hostname= hostname ] [ --port= number ] [ --sampler= name ] [ --retry= seconds ]
[[--nodetach] | [ --detach= directory [ --set-user= username ] [ --pid-file= filename ] [--[no]lock-pid-file] [ --log-file= filename ] ]]
[--cne-protocol=http(s)] [ --cne-path=<path>]
[ --cne-api-port= number ] [ --cne-username= username ] [[ --cne-password= password ] | [ --cne-encrypted-password= encrypted-password ]] [ --cne-timeout= seconds ]
[[--nosnmp] | [ --snmp [ --cne-snmp-port= number ] [ --cne-community= string ]
[ --trap-hostname= hostname ] [ --trap-port= number ] [ --trap-version= version ] ]]
[ --max-cfg-files= number ] [ --api-config= filename ]
[[--brief] | [--verbose] | [--debug]]

geneos-cnpi Geneos sampler parameters Copied

The parameters accepted through the Gateway Setup Editor sampler configuration screen for instances of geneos-cnpi are as follows:

If you are not changing the Geneos group associated with the plugin then skip the following information:

• A current limitation of Geneos API-based applications is that the group generated by the plugin and the group expected by Geneos must be separately configured as the same value. To facilitate this at invocation and every restart, the plugin attempts to read the sampler parameter GROUP and, if found, it replaces the default sampler-name group with the name specified as the value of this parameter. This value should match the group specified in the sampler configuration and the list of expected views if configured.
• If the group names do not match, then corruption of the view displays is likely. To remove this corruption, remove the sampler from the configuration of the managed entity, save the configuration, correct the mismatch, and then add the sampler to the managed entity.
• By default, this plugin places all views within a group that matches the name of the sampler.

trapfod command synopsis Copied

The trap fan-out daemon will receive SNMP traps from CNEs at its configured hostname and port, and route in accordance with requests received from geneos-cnpi instances. It will communicate with Geneos through the specified Geneos managed entity managed-entity and, optionally, any values provided through --hostname, --port, and --sampler, where it will receive its Geneos configuration and generate views on the performance of the trap-forwarding function.

You can refer to the trapfod daemon invocation and command line options below to configure the trapfod command:

trapfod managed-entity
[--version] [--help]
[ --hostname= hostname ] [ --port= number ] [ --sampler= name ] [ --retry= seconds ]
[[--nodetach] | [ --detach= directory [ --set-user= username ] [ --pid-file= filename ] [--[no]lock-pid-file] [ --log-file= filename ] ]]
[ --trap-hostname= hostname ] [ --trap-port= number ] [ --source-OID= OID ]
[[--brief] | [--verbose] | [--debug]]

trapfod Geneos sampler parameters Copied

The parameters accepted through the Gateway Setup Editor sampler configuration screen for instances of trapfod are as follows:

If you are not changing the Geneos group associated with the plugin then skip the following information:

• A current limitation of Geneos API-based applications is that the group generated by the plugin and the group expected by Geneos must be separately configured as the same value. To facilitate this at invocation and every restart, the plugin attempts to read the sampler parameter GROUP and, if found, it replaces the default sampler-name group with the name specified as the value of this parameter. This value should match the group specified in the sampler configuration and the list of expected views if configured.
• If the group names do not match then corruption of the view displays is likely. To remove this corruption, remove the sampler from the configuration of the managed entity, save the configuration, correct the mismatch, and then add the sampler to the managed entity.
• By default, this plugin places all views within a group that matches the name of the sampler.