Geneos ["Geneos"]
["Geneos > Netprobe"]["User Guide"]

CorvilNet

Overview

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 plug-in.

When set up, the integration and its associated API plug-in comprise the CorvilNet plug-in (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.

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 with respect to each known CNE.
  • fodCNPIStatus — shows the status of the trap forwarding process with respect to 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 plug-in from its source integration files. Once the integration is set up, the dataviews become available through the API plug-in.

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

Intended audience

This guide is directed towards 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

The following requirements must be met prior to 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

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

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

Connecting to a CorvilNet Engine

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.

Connecting to a Latency Management Centre

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.

Integration steps — CorvilNet Engine monitoring

The CorvilNet integration involves the following tasks:

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

Download the integration files

  1. On the ITRS Downloads page, download the CorvilNet integration files (geneos-cnpi-1.3.2032.tar.gz).
  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

  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 plug-in with a managed entity

  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

  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 plug-in start-up script variables.

Run the CorvilNet start-up script

  1. Open the Terminal.
  2. Enter the following command:
  3. 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.

Additional steps — Latency Management Centre

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

  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

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

    bash$ chmod u+x fod_cnpi

  3. 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

  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.
  3. Success: After you set the FOD parameters, the API sampler begins to interact with the trapFOD.

Encryption utility

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:
  4. .\cnpi-crypt [your CNE password]

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

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

Shutdown script

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

  1. Locate the PID file in the {LogLocation} you specified in CorvilNet.
  2. Open the Terminal.
  3. Enter the following command, specifying the {LogLocation} and the PID file on your system. For example:
  4. bash$ kill $(cat /home/user/log/geneos-cnpi.pid )

    Success: This command kills the process associated with the CNPI.

Default metrics and dataviews

cnpiConfig

Headline field Description
version Version number of the CNPI software.
hostName Network hostname of the Netprobe that the CNPI is connected to.
port Network port of the Netprobe that the CNPI is connected to.
retryInterval

Delay between attempts to recover from network failures.

Unit: seconds (s)

loggingTo Name of the log file that the CNPI is writing to.
cneHostName Network hostname of the CNE that the CNPI is connected to.
cneAPIPort

Network port configured on the partner CNE to accommodate API queries from the CNPI.

snmpTrapAlerts

Indicates if the CNPI allows SNMP traps.

cneSNMPPort

Network port configured on the partner CNE to accommodate SNMP queries from the CNPI.

trapHostName

Hostname or IP address of the machine where the CNPI is running.

This field is used to receive SNMP traps from either the CNE or the trapFOD.

trapPort

Network port of the machine where the CNPI is running.

This field is used to receive SNMP traps from either the CNE or the trapFOD.

detached

Indicates if the CNPI is running as a detached daemon process (Y) or if it attached to the initiating terminal (N).

workingDirectory

File path or working directory where the CNPI log files are written, and where the PID file associated with the CNPI process is located.

UID User ID associated with the running CNPI process.
pidFile

Name of the PID file that the CNPI process is associated with.

logLevel Logging level set for the CNPI.
group Geneos group in effect for communication with the CNPI.
licenseExpires

Date and time when an evaluation or rental license expires.

If you are on a perpetual license, then this field displays NEVER.

upTime

Elapsed time since the CNPI started, or was restarted.

Unit: seconds (s)

qosAlerts and systemAlerts

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.
Headline field Description
totalAlerts Total number of notifications or alerts.
numAlertsSet Number of notifications or alerts currently set.
numAlertsClear Number of notifications or alerts currently clear.
numseverityAlertsSet

Number of notifications or alerts currently set at a particular level of severity.

For more information, see the severityfield under the column fields.

numseverityAlertsClear

Number of notifications or alerts currently clear at a particular level of severity.

For more information, see the severityfield under the column fields.

Column field Description
type Type of the event generating the notification or alert.
time Time of the notification or alert, in a human-readable format.
timestamp Time of the notification or alert, in Unix time.
severity

The severity of the notification or alert.

Possible values:

  • informational
  • warning
  • minor
  • major
  • severe
deviceIP IP address of the CNE that generated the notification or alert.
sourceFQN Fully-qualified name of the CNE source object that generated the notification or alert.
description Description of the notification or alert.
reason Reason for the set or clear notification.
value Where applicable, this field shows the measured value for the variable monitored by this notification or alert.
typeDiscriminator

CNE descriptor specific to the notification or alert type.

count Where applicable, this field shows the number of times the event occurred within a measurement period.

CorvilNet API metrics and dataviews

The next three views come from the CNE network monitoring statistics. These are passed onto Geneos through the CNPI.

These views do not appear by default, and require you to configure the API sampler you set up for the CNPI.

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

Headline field Description
measurementPoint Fully qualified name of the measurement point to which data in a particular row relates. This is also the key for Geneos snoozing purposes.
cfgFile Source configuration file that specifies the content of the view.
updateIntervalSeconds

Time between refreshes of the contents of this view.

Unit: seconds (s)

updateInterval Time between refreshes of the contents of this view, as it appears in the source configuration file.
noDataValues

Indicates how the CNPI displays "no data" values.

For more information, see CorvilNet.

getStats view

Headline field Description
measurementPoint Fully-qualified name of the measurement-point to which data in a particular row relates. This is also the key for Geneos snoozing purposes.
cfgFile Source configuration file that specifies the content of the view.
updateIntervalSeconds

Time between refreshes of the contents of this view.

Unit: seconds (s)

updateInterval Time between refreshes of the contents of this view, as it appears in the source configuration file.
noDataValues

Indicates how the CNPI displays "no data" values.

For more information, see CorvilNet.

historyPeriodSeconds

Duration of the period for which historical statistics are shown.

This field only appears if you configure a variable time period.

Unit: seconds (s)

historyPeriod Duration of the period for which historical statistics are shown, as it appears in the source configuration file.
dayStartTime

Start of the configured business day.

This field only appears if you configure a BUSINESS-DAY period.

dayEndTime

End of the configured business day.

This field only appears if you configure a BUSINESS-DAY period.

startTimestampMs

Start of the period reported in this view, in Unix time, as reported by the CNE.

Unit: milliseconds (ms)

startTime Start of the period reported in this view in human-readable format.
endTimestampMs

End of the period reported in this view, in Unix time, as reported by the CNE.

Unit: milliseconds (ms)

endTime End of the period reported in this view in human-readable format.
lastUpdatedTimestampMS Local time when the data displayed in the view was requested from the CNE, in Unix time.
lastUpdatedTime Local time when the data displayed in the view was requested from the CNE, in human-readable format.

getLiveStats view

Headline field Description
measurementPoint Fully-qualified name of the measurement-point to which data in a particular row relates. This is also the key for Geneos snoozing purposes.
cfgFile Source configuration file that specifies the content of the view.
updateIntervalSeconds

Time between refreshes of the contents of this view.

Unit: seconds (s)

updateInterval Time between refreshes of the contents of this view, as it appears in the source configuration file.
noDataValues

Indicates how the CNPI displays "no data" values.

For more information, see CorvilNet.

timestamp Timestamp of the most recent response from the CNE, in Unix time.
time Timestamp of the most recent response from the CNE, in human-readable format.
lagOffsetMs

Delay from the initial measurement update time.

Unit: milliseconds (ms)

trapfod metrics and dataviews

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

Headline field Description
version

Version number of the trapFOD software.

This must match the version number of the CNPI that communicates with the trapFOD.

hostName

Network hostname of the Netprobe that the trapFOD is connected to.

port

Network port of the Netprobe that the trapFOD is connected to.

retryInterval

Delay between attempts to recover from network failures.

Unit: seconds (s)

loggingTo Name of the log file that the trapFOD is writing to.
trapRxHostName

Network hostname through which trapFOD expects to receive SNMP traps.

trapRxPort Network port through which trapFOD expects to receive SNMP traps.
sourceOID

Corvil-specific OID of the element within the trap that is expected to contain that IP address.

SNMP traps are decoded upon arrival, and the IP address of the sender of the trap is identified from its contents.

detached

Indicates if the trapFOD is running as a detached daemon process (Y) or if it attached to the initiating terminal (N).

workingDirectory

File path or working directory where the trapFOD log files are being written, and where the PID file associated with the trapFOD process is located.

UID

User ID associated with the trapFOD process.

pidFile

Name of the PID file that the trapFOD process is associated with.

logLevel Logging level set for the trapFOD.
group Geneos group in effect for the CNPI.
licenseExpires

Date and time when an evaluation license expires.

upTime

Elapsed time since the trapFOD started, or was restarted.

Column field Description
row

Numeric key allocated for this row when an error in generated.

Once allocated, an error text will always have the same row number and can be used for snoozing purposes. This is reset when you cold-start the trapFOD.

severity

Severity of an error.

Possible values:

  • WARNING — indicates that the trapFOD may not function as expected.
  • ERROR — indicates that the trapFOD is not functioning as expected.
message Error description.

fodCNEStatus view

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.

Headline field Description
numCNEs

Number of CNE known to the system. This is the number of unique CNE IP addresses received in forward-requests or traps.

This number matches the number of rows in the view.

numTraps Number of traps received in total (both forwarded and not forwarded).
numTrapsFwd Number of traps received that have been forwarded to a subscribing CNPI.
numTrapsDiscarded Number of traps received that have not been forwarded to a subscribing CNPI because no matching subscriber was known at the time of trap receipt.
numErrors Number of rows in the view that have a status value of ERROR.
numWarnings Number of rows in the view that have a status value of WARNING.
time Time when the view was most recently updated, in Unix time.
timestamp Time when the view was most recently updated, in human-readable format.
Column field Description
CNE IP address of the CNE to which this row relates.
status

Status of this CNE from a trap-forwarding perspective.

Possible values:

  • OK — the CNE is communicating without problem.
  • WARNING — there is a risk that some traps may not appear in Geneos, and may require investigation.
  • ERROR — traps generated by the CNE will not appear on Geneos, and require corrective action.
time Time when this row was most recently updated, in Unix time.
timestamp Time when this row was most recently updated, in human-readable format.
subscriberManagedEntity Managed Entity of the CNPI  receiving traps from this CNE.
subscriberSampler Sampler of the CNPI receiving traps from this CNE.
numTraps Total number of traps received from this CNE.
numTrapsFwd Number of traps received from this CNE and forwarded to the subscribing CNPI.
numTrapsDiscarded Number of traps received from this CNE but not forwarded to a subscribing CNPI because no CNPI was known at the time of receipt.
statusDetails

Description of any issue indicated by the statusvalue for this row.

If the status value is OK, then this cell is blank.

fodCNPIStatus view

Headline field Description
numCNPIs

Number of CNPIs known to the system.

This is the number of unique managed entity–sampler combinations received in forward requests.

This number matches the number of rows in the view.

numTrapsFwd Number of traps forwarded to a subscribing CNPIs.
numErrors Number of rows in the view that have a status value of ERROR.
numWarnings Number of rows in the view that have a status value of WARNING.
time Time when the view was most recently updated, in Unix time.
timestamp Time when the view was most recently updated, in human-readable format.
Column field Description
CNPI

Managed entity and sampler names associated with the CNPI in this row.

The value is shown in the format <managedEntityName>:<samplerName>.

status

Status of this CNPI from a trap-forwarding perspective.

Possible values:

  • OK — the CNPI is communicating without problem.
  • WARNING — there is a risk that the CNPI will not receive traps from its partner CNE, and may require investigation.
  • ERROR — the CNPI will not receive traps from its partner CNE, and requires corrective action.
time Time when this row was most recently updated, in Unix time.
timestamp Time when this row was most recently updated, in human-readable format.
partnerCNE

IP address of the CNE from which the CNPI requests to receive traps.

trapSocket

Network address through which the CNPI requests to receive traps.

This value is shown in the format <IPaddress:port>.

numTrapsFwd Number of traps received from the indicated partner CNE and forwarded to CNPI.
statusDetails

Description of any issue indicated by the statusvalue for this row.

If the status value is OK, then this cell is blank.

Appendix

CorvilNet plug-in start-up script variables

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}

# 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
$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" \
--trap-hostname=$TRAP_HOSTNAME \
--trap-port=$TRAP_PORT \
--brief

# start_cnpi
Variable Example value Description
{UnpackLocation} /home/user/cnpi The directory where you unpacked the CorvilNet integration files downloaded from the ITRS Downloads page.
{HostType} Linux_x86_64

The subdirectory of the CorvilNet integration source files appropriate to the operating system in which the plug-in is being installed.

By default, this is Linux_x86_64.

{PlugInVersion} geneos-cnpi-1.3.2032

The subdirectory containing all the CorvilNet integration files.

By default, this is the top-level directory name of the unpacked files.

{LogLocation} /home/user/log

The directory where you want the CorvilNet plug-in to write its output files:

  • log files
  • process identifier (PID) files
{ManagedEntity} CN The name of the managed entity that you set up in Associate the API plug-in with a managed entity.
{LocalHost} localhost

The network address or hostname of the Netprobe you want to associate with the CorvilNet plug-in.

If the Netprobe is running on the same machine as the CorvilNet plug-in, then this is localhost.

{Port} 7036 The port number of the Netprobe you want to associate with the CorvilNet plug-in.
{SamplerName} CNE The name of the sampler that you set up in Set up the API sampler.
{APIHostName} 198.51.100.0 The network address or hostname of the CNE that you want to monitor.
{APIPort} 5101 The port number of the CNE that you want to monitor.
{Username} geneosuser The username you use to access the CNE you want to monitor.
{EncryptedPassword} encryptedpassword

The password associated with the username you use to access the CNE.

The password must be encrypted using the utility supplied with the CorvilNet Integration files. For more information, see Encryption utility.

{SNMPPort} 161 The SNMP port of the CNE you want to monitor.
{CommunityString} string The SNMP community string of the CNE you want to monitor.
{TrapHostname} 192.0.2.0 The network address or hostname of the network interface where the CNE can send SNMP traps. This should be on the same machine where the CNPI is running.
{TrapPort} 5555 The port of the network interface where the CNE can send SNMP traps. This should be on the same machine where the CNPI is running.

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. For more information on commands available to the CNPI, see CNPI commands.

trapFOD start-up script variables

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 you system credentials into the start script.

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

# The location where the plug-in 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 plug-in 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
Variable Example value Description
{UnpackLocation} /home/user/cnpi The directory where you unpacked the CorvilNet integration files downloaded from the ITRS Downloads page.
{HostType} Linux_x86_64

The subdirectory of the CorvilNet integration source files appropriate to the operating system in which the plug-in is being installed.

By default, this is Linux_x86_64.

{PlugInVersion} geneos-cnpi-1.3.2032

The subdirectory containing all the CorvilNet integration files.

By default, this is the top-level directory name of the unpacked files.

{LogLocation} /home/user/log

The directory where you want the CorvilNet plug-in to write its output files:

  • log files
  • process identifier (PID) files
{ManagedEntity} CN The name of the managed entity that you set up in Associate the API plug-in with a managed entity.
{LocalHost} localhost

The network address or hostname of the Netprobe you want to associate with the CorvilNet plug-in.

If the Netprobe is running on the same machine as the CorvilNet plug-in, then this is localhost.

{Port} 7036 The port number of the Netprobe you want to associate with the CorvilNet plug-in.
{SamplerName} CNE The name of the sampler that you set up in Set up the API sampler.
{TrapHostname} 192.0.2.0 The network address or hostname of the network interface where the CNE can send SNMP traps. This should be on the same machine where the CNPI is running.
{TrapPort} 5555 The port of the network interface where the CNE can send SNMP traps. This should be on the same machine where the CNPI is running.

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. For more information on commands available to the trapFOD, see trapFOD commands.