NCPA Staging

This help documentation explains the inner workings of NCPA as well as providing a reference for configuring and setting up NCPA instances. If you&#8217;ve never used NCPA before, and have not yet installed it on a machine &#8211; you can take a look at the&nbsp;<a href="https://nagios.org/ncpa/getting-started.php">getting started guide</a>&nbsp;&nbsp;available on the NCPA website, which will go through the initial installation admin setup, and show you how start monitoring with passive or active checks using either Nagios XI or Nagios Core.



This help documentation is geared towards those who have already installed NCPA and are looking at more advanced configuration and setup using this help as a reference. More guides and documentation can be found on the&nbsp;<a href="https://nagios.org/ncpa/">NCPA website</a>



<h2 class="wp-block-heading" id="anchor-NCPA-3.x-Single-Service">NCPA 3.x Single Service</h2>



In previous versions, NCPA ran as two separate services:



<ul>
<li>NCPA Listener</li>



<li>NCPA Passive</li>
</ul>



The&nbsp;NCPA Listener&nbsp;service would listen for active checks coming from a Nagios Core or Nagios XI system. The&nbsp;NCPA Passive&nbsp;service would send service check results back to a Nagios Core or Nagios XI system.



With the relase of NCPA 3.0, the passive functionality has been rolled into a single&nbsp;NCPA&nbsp;service. By default, the service will run as the&nbsp;nagios&nbsp;user and group. This can be changed by modifying the&nbsp;uid&nbsp;and&nbsp;gid&nbsp;(for user and group, respectively) settings in the&nbsp;ncpa.cfg&nbsp;file.



<h3 class="wp-block-heading">NCPA Service</h3>



The&nbsp;NCPA&nbsp;service does the following:



<ul>
<li>Serves and handles connections to the web GUI</li>



<li>Handles external API requests (including those for active checks)</li>



<li>Provides API for live graphing and top processes</li>



<li>Provides an &#8220;offline&#8221; internal API for the&nbsp;NCPA Passive&nbsp;process</li>



<li>Runs passive checks defined in the [passive checks] configuration section</li>



<li>Connects and sends passive check results to the defined NRDP URL</li>
</ul>



<h2 class="wp-block-heading" id="anchor-Restarting-the-NCPA-Service">Restarting the NCPA Service</h2>



You will need to restart the NCPA service whenever a configuration change is made.<a href="https://www.nagios.org/ncpa/help/3.0/index.html#windows"></a>



<h3 class="wp-block-heading">Restarting NCPA on Windows</h3>



You can also view the services in the Windows services administration panel, but you can also do it easily from CMD.



You can also affect services through Powershell. The verbs will be&nbsp;Start,&nbsp;Stop, and&nbsp;Restart.&nbsp;Start&nbsp;will start a service that is not running.&nbsp;Stop&nbsp;will stop a service that is not running.&nbsp;Restart&nbsp;will stop and then start a service if it is running, or just start a service if it is not running. The Powershell cmdlets can be found below.



<pre class="wp-block-code code-block"><code>Start-Service ncpa 
Stop-Service ncpa 
Restart-Service ncpa</code></pre>



<h3 class="wp-block-heading" id="Restarting-NCPA-on-Linux">Restarting NCPA on Linux</h3>



This example should work for all supported Linux distros. If you are running v3+ on an older distro (it may run, even if not supported), you may need to use chkconfig or service commands vs. systemctl.



<pre class="wp-block-code"><code>systemctl restart ncpa</code></pre>



<h3 class="wp-block-heading">Restarting NCPA on Mac OS X</h3>


<div class="wp-block-kevinbatdorf-code-block-pro cbp-has-line-numbers codeBlockPro" style="font-size: .875rem; font-family: Code-Pro-Geist-Mono,ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,monospace; --cbp-line-number-color: #EEFFFF; --cbp-line-number-width: calc(1 * 0.6 * .875rem); line-height: 1.25rem; --cbp-tab-width: 2; tab-size: var(--cbp-tab-width, 2);" data-code-block-pro-font-family="Code-Pro-Geist-Mono">Zsh
<pre class="shiki material-theme" style="background-color: #263238;" tabindex="0"><code>sudo launchctl stop com.nagios.ncpa
sudo launchctl start com.nagios.ncpa</code></pre>
</div>


<h2 class="wp-block-heading" id="anchor-Change-Log">Change Log</h2>



You can view the full changelog on the&nbsp;<a href="https://github.com/NagiosEnterprises/ncpa/blob/master/CHANGES.rst">NCPA GitHub repository</a>



<h2 class="wp-block-heading" id="anchor-Troubleshooting-NCPA">Troubleshooting NCPA</h2>



Sometimes when setting up NCPA things don&#8217;t work out the first time. We&#8217;ve compiled a few troubleshooting tips and things that could happen that might give people headaches.



<h6 class="wp-block-heading">Checking for problems in the logs</h6>



Typically if there is an&nbsp;error&nbsp;you will always see that error logged, no matter what your log level since error is the most filtered log level available. However, sometimes Python errors will occur before logging starts in Windows systems. You can normally find these errors in the log files located in the same directory as the .exe files in the Windows Program Files directory that you installed NCPA into.



That being said, a good habit to get into is setting your&nbsp;<code>loglevel</code>&nbsp;to&nbsp;debug&nbsp;when you are running into trouble where something is not working correctly. If you do this, and restart your NCPA services, we can get a better idea of what is going on and when it&#8217;s going in the code. If you can&#8217;t figure out the issue from reading the debug log, post it in an issue on&nbsp;<a href="https://github.com/NagiosEnterprises/ncpa">GitHub</a>&nbsp;&nbsp;and the developers can take a look.



<h6 class="wp-block-heading">Make sure your checks do not use&nbsp;api&nbsp;node</h6>



For both passive and active checks, when you are configuring them, do not use the&nbsp;api&nbsp;section when specifying the endpoint to run. Examples below:


<div class="wp-block-kevinbatdorf-code-block-pro cbp-has-line-numbers" style="font-size: .875rem; font-family: Code-Pro-Geist-Mono,ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,monospace; --cbp-line-number-color: #EEFFFF; --cbp-line-number-width: calc(1 * 0.6 * .875rem); line-height: 1.25rem; --cbp-tab-width: 2; tab-size: var(--cbp-tab-width, 2);" data-code-block-pro-font-family="Code-Pro-Geist-Mono">Bash
<pre class="shiki material-theme" style="background-color: #263238;" tabindex="0"><code>./check_ncpa.py -H &lt;ncpa server&gt; -t '&lt;your token&gt;' -M 'disk/logical/C:|' --units G
%HOSTNAME%|&lt;service name&gt; = disk/logical/C:| --units G</code></pre>
</div>


Note that the&nbsp;<code>disk/logical/C:|</code>&nbsp;does not have the&nbsp;<code>api</code>&nbsp;portion applied. Remember that checks do not need a beginning forward slash. A good way to avoid using the wrong path is by viewing an example check for the endpoint you are making a check for from the API tab.

Overview 3.0

This help documentation explains the inner workings of NCPA as well as providing a reference for configuring and setting up NCPA instances. If you&#8217;ve never used NCPA before, and have not yet installed it on a machine &#8211; you can take a look at the <a href="https://nagios.org/ncpa/getting-started.php">getting started guide</a> available on the NCPA website, which will go through the initial installation admin setup, and show you how start monitoring with passive or active checks using either Nagios XI or Nagios Core.



This help documentation is geared towards those who have already installed NCPA and are looking at more advanced configuration and setup using this help as a reference. More guides and documentation can be found on the <a href="https://nagios.org/ncpa/">NCPA website</a> .<a></a>



<h2 class="wp-block-heading">NCPA 3.x Single Service</h2>



In previous versions, NCPA ran as two separate services:



<ul>
<li>NCPA Listener</li>



<li>NCPA Passive</li>
</ul>



The NCPA Listener service would listen for active checks coming from a Nagios Core or Nagios XI system. The NCPA Passive service would send service check results back to a Nagios Core or Nagios XI system. With the relase of NCPA 3.0, the passive functionality has been rolled into a single NCPA service. By default, the service will run as the nagios user and group. This can be changed by modifying the uid and gid (for user and group, respectively) settings in the ncpa.cfg file.



<h3 class="wp-block-heading">NCPA Service</h3>



The NCPA service does the following:



<ul>
<li>Serves and handles connections to the web GUI</li>



<li>Handles external API requests (including those for active checks)</li>



<li>Provides API for live graphing and top processes</li>



<li>Provides an &#8220;offline&#8221; internal API for the NCPA Passive process</li>



<li>Runs passive checks defined in the [passive checks] configuration section</li>



<li>Connects and sends passive check results to the defined NRDP URL</li>
</ul>

Overview 2.0

While NCPA has many features, configuring your initial NCPA install can be tricky. This help documentation is here to explain the inner workings of NCPA as well as a reference when configuring and setting up NCPA instances.



This help documentation is geared towards those who have already installed NCPA and are looking at more advanced configuration and setup using this help as a reference. To start off, below is a brief overview of the parts of NCPA and what they are responsible for.



<h3 class="wp-block-heading" id="The-Two-Parts-of-NCPA">The Two Parts of NCPA</h3>



NCPA is actually two separate services that make up a single monitoring agent. This separation allows the ability for the agent to run passive checks without needing to allow connections to the web GUI or allow external calls to the API. It also allows the passive portion of the agent to be disabled if it&#8217;s not in use to save resources even though the passive portion requires very few resources while running in the background.



By default in NCPA 2, both services run as the&nbsp;nagios&nbsp;user and&nbsp;nagios&nbsp;group. The user and group can be changed in the&nbsp;ncpa.cfg.



<div class="wp-block-columns is-layout-flex wp-container-core-columns-is-layout-1 wp-block-columns-is-layout-flex">
<div class="wp-block-column is-layout-flow wp-block-column-is-layout-flow">
<h3 class="wp-block-heading">NCPA Listener</h3>



The&nbsp;NCPA Listener&nbsp;service does the following:



<ul>
<li>Serves and handles connections to the web GUI</li>



<li>Handles external API requests (including those for active checks)</li>



<li>Provides API for live graphing and top processes</li>



<li>Provides and &#8220;offline&#8221; internal API for the&nbsp;NCPA Passive&nbsp;service</li>
</ul>
</div>



<div class="wp-block-column is-layout-flow wp-block-column-is-layout-flow">
<h3 class="wp-block-heading">NCPA Passive</h3>



The&nbsp;NCPA Passive&nbsp;service does the following:



<ul>
<li>Runs passive checks defined in the [passive checks] configuration section</li>



<li>Connects and sends passive check results to the defined NRDP URL</li>
</ul>
</div>
</div>



<h3 class="wp-block-heading" id="Restarting-the-NCPA-Services">Restarting the NCPA Services</h3>



Because NCPA is made up of these two separate services, you will need to restart both of them if you are using both the active and passive capabilities. Below is the naming conventions and the command line way of restarting both services. In the configuration section you&#8217;ll find that you will need to restart the services each time configuration changes are made.



Windows



You can also view the services in the windows services administration panel, but you can also do it easily from the command line.



<pre class="wp-block-code"><code>net stop ncpalistener
net start ncpalistener</code></pre>



<pre class="wp-block-code"><code>net stop ncpapassive
net stop ncpapassive</code></pre>



Linux



This is an example for&nbsp;CentOS 6. However, the services are named the same in all Linux distros we build for.



<pre class="wp-block-code"><code>service ncpa_listener restart</code></pre>



<pre class="wp-block-code"><code>service ncpa_passive restart</code></pre>



Mac OS X



Unfortunately there is not a&nbsp;restart&nbsp;command for&nbsp;<code>launchctl</code>&nbsp;at this time.



<pre class="wp-block-code"><code>sudo launchctl stop com.nagios.ncpa.listener
sudo launchctl start com.nagios.ncpa.listener</code></pre>



<pre class="wp-block-code"><code>sudo launchctl stop com.nagios.ncpa.passive
sudo launchctl start com.nagios.ncpa.passive</code></pre>



<h3 class="wp-block-heading" id="Changes-from-2.0-to-2.1">Changes from 2.0 to 2.1</h3>



You can also view the full changelog on the&nbsp;<a href="https://github.com/NagiosEnterprises/ncpa/blob/master/CHANGES.rst">NCPA GitHub repository</a>&nbsp;.



<ol>
<li>Passing arguments via parameters for plugins&nbsp;&#8211; You can now pass plugin arguments using parameters instead of through the path, so using&nbsp;<code>?args=&lt;arg1&gt;&amp;args=&lt;arg2&gt;</code>&nbsp;instead of&nbsp;<code>/arg1/arg2</code>&nbsp;alleviates some problems passing certain variables. Certain things, like drive names, will pass properly using parameters.</li>



<li>Long output&nbsp;&#8211; Both the&nbsp;<code>processes</code>&nbsp;and&nbsp;<code>logs</code>&nbsp;endpoints now return long output. Both show data on what was returned from the check.</li>



<li>Processes check returns total perfdata&nbsp;&#8211; Process checks return the total amount of cpu usage, memory, etc that all processes that match are using.</li>



<li>New configuration options&nbsp;&#8211; New configuration options available:
<ol>
<li><code>run_with_sudo</code>&nbsp;&#8211; Comma separated list of plugin names that should be ran through sudo</li>



<li><code>allowed_hosts</code>&nbsp;&#8211; Comma separated list of IP addresses that can access the agent</li>



<li><code>default_units</code>&nbsp;&#8211; The default units to use (G, Gi, etc)</li>



<li><code>exclude_fs_types</code>&nbsp;&#8211; Comma separated list of file system types to ignore</li>
</ol>
</li>



<li>Multiple NRDP receivers&nbsp;&#8211; You can now put multiple NRDP parents in the configuration (and tokens for those parents) using a comma separated list.</li>



<li>Added Kafka for passive checks&nbsp;&#8211; Thanks to a contributer on GitHub, you can now send passive checks out through Kafka. Configuration options example in the&nbsp;<code>nagios.cfg</code>&nbsp;file.</li>



<li>Interface checks&nbsp;&#8211; The&nbsp;<code>interface</code>&nbsp;node checks can now be performed on an interface, which will show the entire status of packets/bytes sent and received all in one check.</li>
</ol>



<h3 class="wp-block-heading">Changes from 1.x to 2.x</h3>



The latest version of NCPA has a lot of major changes that affect users of older versions of NCPA. Since these changes are in multiple sections of NCPA 2, we have created list of the most notable changes that could affect your system when upgrading from an older version.



<ol>
<li>Updated check_ncpa.py plugin&nbsp;&#8211; There is a new version of&nbsp;<code>check_ncpa.py</code>&nbsp;(version 1.0) and should be updated.&nbsp;Version 1.0+ is compatible with NCPA 1.x and 2.x so you can update at any time.&nbsp;If you are using Nagios XI, update your NCPA wizard in the Admin &gt; Manage Config Wizards section. If you are using Nagios Core, you can&nbsp;<a href="https://raw.githubusercontent.com/NagiosEnterprises/ncpa/master/client/check_ncpa.py">download the new plugin from GitHub</a>&nbsp;.</li>



<li>API output JSON format&nbsp;&#8211; With NCPA 2, the JSON output no longer sends&nbsp;<code>value</code>. Instead, it&#8217;s output is just a JSON object, formatted the way it should be returned based on the node that was called and whether or not it is a check. This change is already accounted for in the new&nbsp;<code>check_ncpa.py</code>&nbsp;plugin (version 1.0+) and is available in both Nagios XI and Nagios Core. See above for instructions.</li>



<li>Configuration folder&nbsp;&#8211; You can now put configuration files into the&nbsp;<code>ncpa.cfg.d</code>&nbsp;folder to be included into the main&nbsp;<code>ncpa.cfg</code>&nbsp;configuration file.</li>



<li>Renamed&nbsp;agent/plugin&nbsp;node to&nbsp;plugins&nbsp;&#8211; Due to the confusion of the naming convention for the&nbsp;<code>api/agent/plugin</code>&nbsp;node, we have renamed this node to&nbsp;<code>api/plugins</code>&nbsp;which fits the current node layout better. This change affects both active and passive checks.&nbsp;The old node is still able to be used, so no immediate changes are necessary, but it is deprecated and will be removed in future versions of NCPA.</li>



<li>Changes to unit types&nbsp;&#8211; Most units that were considered bytes returned the unit&nbsp;b&nbsp;instead of the proper unit&nbsp;B. The&nbsp;<code>units</code>&nbsp;variable also now will only affect the&nbsp;B&nbsp;and&nbsp;b&nbsp;unit types. All other types can only be overridden by&nbsp;<code>unit</code>, which sets the unit to something other than the default unit used.</li>



<li>Deprecated&nbsp;service&nbsp;and&nbsp;process&nbsp;nodes&nbsp;&#8211; With older versions of NCPA, it was typical to use the format&nbsp;<code>api/service/&lt;servicename&gt;</code>&nbsp;and&nbsp;<code>api/process/&lt;processname&gt;</code>&nbsp;for both the service and process nodes. However, in NCPA 2, the nodes will forward to the new&nbsp;<code>api/services?service=&lt;servicename&gt;</code>&nbsp;and&nbsp;<code>api/processes?name=&lt;processname&gt;</code>&nbsp;instead.&nbsp;The old node endpoints will be removed in future versions of NCPA.</li>



<li>Individual passive check intervals&nbsp;&#8211; You can now define an individual passive check interval by appending&nbsp;<code>|&lt;check interval in seconds&gt;</code>&nbsp;after there service name. If an individual check interval is not defined, the global default sleep value set in your config will be used.</li>



<li>Renamed ncpa_posix_listener and ncpa_posix_passive service names to ncpa_listener and ncpa_passive&nbsp;&#8211; Due to the services being named ncpa_listener and ncpa_passive in the init.d scripts, it makes more sense to not name them with the posix section anymore.</li>
</ol>



<h3 class="wp-block-heading">Troubleshooting</h3>



Sometimes when setting up NCPA things don&#8217;t work out the first time. We&#8217;ve compiled a few troubleshooting tips and things that could happen that might give people headaches.



<h6 class="wp-block-heading">Checking for problems in the logs</h6>



Typically if there is an&nbsp;error&nbsp;you will always see that error logged, no matter what your log level since error is the most filtered log level available. However, sometimes Python errors will occur before logging starts in Windows systems. You can normally find these errors in the log files located in the same directory as the .exe files in the Windows Program Files directory that you installed NCPA into.



That being said, a good habit to get into is setting your&nbsp;<code>loglevel</code>&nbsp;to&nbsp;debug&nbsp;when you are running into trouble where something is not working correctly. If you do this, and restart your NCPA services, we can get a better idea of what is going on and when it&#8217;s going in the code. If you can&#8217;t figure out the issue from reading the debug log, post it in an issue on&nbsp;<a href="https://github.com/NagiosEnterprises/ncpa">GitHub</a>&nbsp;&nbsp;and the developers can take a look.



<h6 class="wp-block-heading">Make sure your checks do not use&nbsp;api&nbsp;node</h6>



For both passive and active checks, when you are configuring them, do not use the&nbsp;api&nbsp;section when specifying the endpoint to run. Examples below:



<pre class="wp-block-code"><code>./check_ncpa.py -H &lt;ncpa server&gt; -t '&lt;your token&gt;' -M 'disk/logical/C:|' --units G</code></pre>



<pre class="wp-block-code"><code>%HOSTNAME%|&lt;service name&gt; = disk/logical/C:| --units G</code></pre>



Note that the&nbsp;<code>disk/logical/C:|</code>&nbsp;does not have the&nbsp;<code>api</code>&nbsp;portion applied. Remember that checks do not need a beginning forward slash. A good way to avoid using the wrong path is by viewing an example check for the endpoint you are making a check for from the API tab.

Overview 2.2

Running active checks against NCPA is fairly straight-forward and follows a similar style as&nbsp;<code>check_nrpe</code>. You should download the latest version of the&nbsp;<a href="https://github.com/NagiosEnterprises/ncpa/blob/master/client/check_ncpa.py">check_ncpa.py plugin</a>&nbsp;&nbsp;from GitHub. This plugin works with NCPA 2+ and is backwards compatible with NCPA 1. This plugin is the standard method for executing active checks. However, because of the design of NCPA, it makes it&nbsp;very&nbsp;easy to use your own methods to collect data at perform active checks, even from a simple&nbsp;<code>curl</code>&nbsp;command. We will leave the choice to you, but we will support active checks through the&nbsp;<code>check_ncpa.py</code>&nbsp;plugin.



<blockquote class="wp-block-quote is-layout-flow wp-block-quote-is-layout-flow">
Note:&nbsp;All the examples in this page are from a Nagios server (either&nbsp;Nagios XI&nbsp;or&nbsp;Nagios Core) because the active checks are set up in Nagios and do not require any changes to be done in NCPA, besides setting up plugin directives or configuring how to access the API.
</blockquote>



Using the plugin will require some knowledge of how the API works. You will also need to make sure you install the plugin in the Nagios libexec (typically&nbsp;<code>/usr/local/nagios/libexec</code>) directory.



<blockquote class="wp-block-quote is-layout-flow wp-block-quote-is-layout-flow">
Tip:&nbsp;If you are using&nbsp;Nagios XI, you can skip installing the plugin manually. By default,&nbsp;Nagios XI&nbsp;comes with a config wizard for NCPA. You can check for updates by going to the&nbsp;Admin &gt; Manage Config Wizards&nbsp;page and clicking on&nbsp;Check for Updates. You can then click the&nbsp;install&nbsp;link in the NCPA config wizard table row to upgrade to the latest version if a new one is available. The config wizard upgrade script will install the latest version of the plugin for you.&nbsp;Running the config wizard is the fastest way to get started with NCPA active checks since it requires no manual configuration.
</blockquote>



<h2 class="wp-block-heading" id="anchor-Running-an-Active-Check-2">Running an Active Check</h2>



While you can run a check through the API in your browser, you will want to use the&nbsp;<code>check_ncpa.py</code>&nbsp;plugin to run these active checks from your Nagios server to have your results show up in Nagios. Once you&#8217;ve installed your plugin on the Nagios server in your&nbsp;<code>libexec</code>&nbsp;directory, you can run it just like any other plugin.



The most important part you&#8217;ll need to do is specify the API endpoint that you want to run the check on. This is done by passing the node endpoint (or as the plugin calls this value, the metric) by the&nbsp;<code>-M</code>&nbsp;argument.



<blockquote class="wp-block-quote is-layout-flow wp-block-quote-is-layout-flow">
Note:&nbsp;You will need to make sure to wrap any node endpoint that uses the&nbsp;<code>disk</code>&nbsp;module with single quotes. This is because NCPA uses the&nbsp;<code>|</code>&nbsp;character instead of slashes. This is to help with running values from URLs in the API. However, the pipe character is a special character in the linux shell and must be escaped by single quotes. Example:&nbsp;<code>-M 'disk/logical/C:|'</code>
</blockquote>



<h6 class="wp-block-heading">Example Check</h6>



A simple check to demonstrate how the plugin works is checking for the used memory percent:



<pre class="wp-block-preformatted">./check_ncpa.py -H &lt;ncpaserver&gt; -t mytoken -M 'memory/virtual/percent'</pre>



The above check will return the following:



<pre class="wp-block-preformatted">OK: Percent was 36.20 % | 'percent'=36.20%;;;</pre>



This is a pretty simple check &#8211; you can do a lot of tweaking to get different output. Read on in the&nbsp;<a href="https://www.nagios.org/ncpa/help/3.0/active.html#using-the-plugin">section that explains how to use the check_ncpa.py plugin</a>&nbsp;to see more options. Most of the base nodes, such as&nbsp;<code>memory/virtual</code>, have special checks that encompass all the child endpoints. You can see an example of that below.



<h6 class="wp-block-heading">Example Check and Specifying Units</h6>



Say we want to see the amount of memory we are using in GB, but NCPA returns the value in B by default. Typically we would add&nbsp;<code>units=G</code>&nbsp;in the API URL call, but the plugin will do this for us. See the example below:



<pre class="wp-block-preformatted">./check_ncpa.py -H &lt;ncpaserver&gt; -t mytoken -M 'memory/virtual/used' -u G</pre>



Will return the GB value instead of the B value:



<pre class="wp-block-preformatted">OK: Used was 13.16 GB | 'used'=13.16GB;;;</pre>







<h2 class="wp-block-heading" id="anchor-Using-the-check_ncpa.py-Plugin-2">Using the check_ncpa.py Plugin</h2>



In this section, we will cover some of the standard use cases and how to use the plugin to achieve specific output. While this section will go over most of the arguments that are available in the plugin, you can also view all the available arguments by using&nbsp;<code>--help</code>.



<blockquote class="wp-block-quote is-layout-flow wp-block-quote-is-layout-flow">
Note:&nbsp;If you encounter problems with the plugin, you can use the&nbsp;<code>-v</code>&nbsp;argument to enable verbose output of problems. There is also a&nbsp;<code>-D</code>&nbsp;argument that enables debugging output.
</blockquote>



<h6 class="wp-block-heading">Warning and Critical Values</h6>



You can send warning (<code>-w</code>&nbsp;or&nbsp;<code>--warning=</code>) and critical (<code>-c</code>&nbsp;or&nbsp;<code>--critical=</code>) values to any value that comes from the API nodes besides the&nbsp;<code>plugins</code>&nbsp;node since&nbsp;these values do not work with plugins. If you need to send the warning and critical values to your plugins,&nbsp;<a href="https://www.nagios.org/ncpa/help/3.0/active.html#plugins">you&#8217;ll have to pass them as plugin arguments</a>.



<pre class="wp-block-preformatted">./check_ncpa.py -H &lt;ncpaserver&gt; -t mytoken -M 'processes' --warning=100 --critical=200</pre>



The output would look something like this:



<pre class="wp-block-preformatted">WARNING: Process count was 177 | 'process_count'=177;100;200;</pre>



You can see that now the perfdata has the warning and critical values set. Also, we see that the system we are checking has over 100 processes and so it shows up as a warning.



<h6 class="wp-block-heading">Sending a Query String</h6>



You can send additional query string arguments in a&nbsp;comma separated list of&nbsp;<code>key=value</code>&nbsp;pairs. If we were interested in getting the CPU Usage (average percent over all cores) of the host that we installed NCPA on, we would run the&nbsp;<code>check_ncpa.py</code>&nbsp;with the&nbsp;<code>-q</code>&nbsp;argument because we need to tell NCPA how to aggregate the CPU usage results. The check would be the following:



<pre class="wp-block-preformatted">./check_ncpa.py -H &lt;ncpaserver&gt; -t mytoken -M 'cpu/percent' -q 'aggregate=avg'</pre>



The above would output the following:



<pre class="wp-block-preformatted">OK: Percent was 2.16 % | 'percent'=2.16%;;;</pre>



If we removed the&nbsp;<code>-q 'aggregate=avg'</code>, which is passing arguments to the URL that the plugin is generating, we would get:



<pre class="wp-block-preformatted">OK: Percent was 7.70 %, 0.00 %, 11.10 %, 0.00 %, 0.00 %, 0.00 %, 3.00 %, 0.00 %, 0.00 %, 0.00 %, 0.00 %, 1.50 %, 0.00 %, 1.50 %, 0.00 %, 3.20 % | 'percent_0'=7.70%;;; 'percent_1'=0.00%;;; 'percent_2'=11.10%;;; 'percent_3'=0.00%;;; 'percent_4'=0.00%;;; 'percent_5'=0.00%;;; 'percent_6'=3.00%;;; 'percent_7'=0.00%;;; 'percent_8'=0.00%;;; 'percent_9'=0.00%;;; 'percent_10'=0.00%;;; 'percent_11'=1.50%;;; 'percent_12'=0.00%;;; 'percent_13'=1.50%;;; 'percent_14'=0.00%;;; 'percent_15'=3.20%;;;</pre>



This check represents an 8 core processor with 16 threads. You can see how it might be helpful to send these extra variables in your checks. If we were to define a warning and critical value above, it would apply to each of the threads instead of the check as a whole.



<h6 class="wp-block-heading">Running Plugins with Arguments</h6>



If you are using the&nbsp;<code>plugins</code>&nbsp;module to execute your own custom scripts, you will likely want to be able to pass arguments to the executed script. To do this, pass the&nbsp;<code>args</code>&nbsp;parameter.&nbsp;<code>check_ncpa.py</code>&nbsp;has&nbsp;<code>-q</code>, which allows you to pass parameters with the request.&nbsp;Make sure you quote the arguments right when you send them; single quotes and double quotes matter here.



If we had a script called&nbsp;<code>test.sh</code>, running it from the command line may look something like this:



<pre class="wp-block-preformatted">./test.sh -u 'one argument' -p 'another argument'</pre>



To run the above script using NCPA and the&nbsp;<code>check_ncpa.py</code>&nbsp;plugin:



<pre class="wp-block-preformatted">./check_ncpa.py -H &lt;ncpaserver&gt; -t mytoken -M 'plugins/test.sh' -q "args=-u 'one argument',args=-p 'another argument'"</pre>



The quotes matter for how the plugin is going to be interpreted by NCPA when it is ran. To see this clearly, check out these examples of how the plugin would create the API call for each quoting example:



<ul>
<li><a href="https://www.nagios.org/ncpa/help/3.0/active.html#with-quotes">With Quotes</a></li>



<li><a href="https://www.nagios.org/ncpa/help/3.0/active.html#without-quotes">Without Quotes</a></li>
</ul>



<pre class="wp-block-preformatted">./check_ncpa.py -H &lt;ncpaserver&gt; -t mytoken -M 'plugins/test.sh' -q "args=-u 'one argument',args=-p 'another argument'"</pre>



The above would give you the following URL:



<pre class="wp-block-preformatted">https://&lt;ncpaserver&gt;/api/plugins/test.sh?args=-u 'one argument'&amp;args=-p 'another argument'</pre>



<h2 class="wp-block-heading" id="anchor-Additional-Features-2">Additional Features</h2>



There are some special arguments that do not run checks that can be used to help test out using the plugin for a specific check.



<h6 class="wp-block-heading">Listing Available Nodes</h6>



You can also use&nbsp;<code>check_ncpa.py</code>&nbsp;to return a representation of all the values you can monitor in a specific API node. This can be very helpful when you are in a terminal without the use of a web browser. You can use the&nbsp;<code>--list</code>&nbsp;(or&nbsp;<code>-l</code>) command to have it list, rather than run a check, on a particular node:



<pre class="wp-block-preformatted">./check_ncpa.py -H &lt;ncpaserver&gt; -t mytoken -M 'disk' --list</pre>



The list command will also work with no specified&nbsp;<code>-M</code>&nbsp;and will list all the base modules available in the API.

test 5

Running active checks against NCPA is fairly straight-forward and follows a similar style as&nbsp;<code>check_nrpe</code>. You should download the latest version of the&nbsp;<a href="https://github.com/NagiosEnterprises/ncpa/blob/master/client/check_ncpa.py">check_ncpa.py plugin</a>&nbsp;&nbsp;from GitHub. This plugin works with NCPA 2+ and is backwards compatible with NCPA 1. This plugin is the standard method for executing active checks. However, because of the design of NCPA, it makes it&nbsp;very&nbsp;easy to use your own methods to collect data at perform active checks, even from a simple&nbsp;<code>curl</code>&nbsp;command. We will leave the choice to you, but we will support active checks through the&nbsp;<code>check_ncpa.py</code>&nbsp;plugin.



<blockquote class="wp-block-quote is-layout-flow wp-block-quote-is-layout-flow">
Note:&nbsp;All the examples in this page are from a Nagios server (either&nbsp;Nagios XI&nbsp;or&nbsp;Nagios Core) because the active checks are set up in Nagios and do not require any changes to be done in NCPA, besides setting up plugin directives or configuring how to access the API.
</blockquote>



Using the plugin will require some knowledge of how the API works. You will also need to make sure you install the plugin in the Nagios libexec (typically&nbsp;<code>/usr/local/nagios/libexec</code>) directory.



<blockquote class="wp-block-quote is-layout-flow wp-block-quote-is-layout-flow">
Tip:&nbsp;If you are using&nbsp;Nagios XI, you can skip installing the plugin manually. By default,&nbsp;Nagios XI&nbsp;comes with a config wizard for NCPA. You can check for updates by going to the&nbsp;Admin &gt; Manage Config Wizards&nbsp;page and clicking on&nbsp;Check for Updates. You can then click the&nbsp;install&nbsp;link in the NCPA config wizard table row to upgrade to the latest version if a new one is available. The config wizard upgrade script will install the latest version of the plugin for you.&nbsp;Running the config wizard is the fastest way to get started with NCPA active checks since it requires no manual configuration.
</blockquote>



<h2 class="wp-block-heading" id="anchor-Running-an-Active-Check-5">Running an Active Check</h2>



While you can run a check through the API in your browser, you will want to use the&nbsp;<code>check_ncpa.py</code>&nbsp;plugin to run these active checks from your Nagios server to have your results show up in Nagios. Once you&#8217;ve installed your plugin on the Nagios server in your&nbsp;<code>libexec</code>&nbsp;directory, you can run it just like any other plugin.



The most important part you&#8217;ll need to do is specify the API endpoint that you want to run the check on. This is done by passing the node endpoint (or as the plugin calls this value, the metric) by the&nbsp;<code>-M</code>&nbsp;argument.



<blockquote class="wp-block-quote is-layout-flow wp-block-quote-is-layout-flow">
Note:&nbsp;You will need to make sure to wrap any node endpoint that uses the&nbsp;<code>disk</code>&nbsp;module with single quotes. This is because NCPA uses the&nbsp;<code>|</code>&nbsp;character instead of slashes. This is to help with running values from URLs in the API. However, the pipe character is a special character in the linux shell and must be escaped by single quotes. Example:&nbsp;<code>-M 'disk/logical/C:|'</code>
</blockquote>



<h6 class="wp-block-heading">Example Check</h6>



A simple check to demonstrate how the plugin works is checking for the used memory percent:



<pre class="wp-block-preformatted">./check_ncpa.py -H &lt;ncpaserver&gt; -t mytoken -M 'memory/virtual/percent'</pre>



The above check will return the following:



<pre class="wp-block-preformatted">OK: Percent was 36.20 % | 'percent'=36.20%;;;</pre>



This is a pretty simple check &#8211; you can do a lot of tweaking to get different output. Read on in the&nbsp;<a href="https://www.nagios.org/ncpa/help/3.0/active.html#using-the-plugin">section that explains how to use the check_ncpa.py plugin</a>&nbsp;to see more options. Most of the base nodes, such as&nbsp;<code>memory/virtual</code>, have special checks that encompass all the child endpoints. You can see an example of that below.



<h6 class="wp-block-heading">Example Check and Specifying Units</h6>



Say we want to see the amount of memory we are using in GB, but NCPA returns the value in B by default. Typically we would add&nbsp;<code>units=G</code>&nbsp;in the API URL call, but the plugin will do this for us. See the example below:



<pre class="wp-block-preformatted">./check_ncpa.py -H &lt;ncpaserver&gt; -t mytoken -M 'memory/virtual/used' -u G</pre>



Will return the GB value instead of the B value:



<pre class="wp-block-preformatted">OK: Used was 13.16 GB | 'used'=13.16GB;;;</pre>







<h2 class="wp-block-heading" id="anchor-Using-the-check_ncpa.py-Plugin-5">Using the check_ncpa.py Plugin</h2>



In this section, we will cover some of the standard use cases and how to use the plugin to achieve specific output. While this section will go over most of the arguments that are available in the plugin, you can also view all the available arguments by using&nbsp;<code>--help</code>.



<blockquote class="wp-block-quote is-layout-flow wp-block-quote-is-layout-flow">
Note:&nbsp;If you encounter problems with the plugin, you can use the&nbsp;<code>-v</code>&nbsp;argument to enable verbose output of problems. There is also a&nbsp;<code>-D</code>&nbsp;argument that enables debugging output.
</blockquote>



<h6 class="wp-block-heading">Warning and Critical Values</h6>



You can send warning (<code>-w</code>&nbsp;or&nbsp;<code>--warning=</code>) and critical (<code>-c</code>&nbsp;or&nbsp;<code>--critical=</code>) values to any value that comes from the API nodes besides the&nbsp;<code>plugins</code>&nbsp;node since&nbsp;these values do not work with plugins. If you need to send the warning and critical values to your plugins,&nbsp;<a href="https://www.nagios.org/ncpa/help/3.0/active.html#plugins">you&#8217;ll have to pass them as plugin arguments</a>.



<pre class="wp-block-preformatted">./check_ncpa.py -H &lt;ncpaserver&gt; -t mytoken -M 'processes' --warning=100 --critical=200</pre>



The output would look something like this:



<pre class="wp-block-preformatted">WARNING: Process count was 177 | 'process_count'=177;100;200;</pre>



You can see that now the perfdata has the warning and critical values set. Also, we see that the system we are checking has over 100 processes and so it shows up as a warning.



<h6 class="wp-block-heading">Sending a Query String</h6>



You can send additional query string arguments in a&nbsp;comma separated list of&nbsp;<code>key=value</code>&nbsp;pairs. If we were interested in getting the CPU Usage (average percent over all cores) of the host that we installed NCPA on, we would run the&nbsp;<code>check_ncpa.py</code>&nbsp;with the&nbsp;<code>-q</code>&nbsp;argument because we need to tell NCPA how to aggregate the CPU usage results. The check would be the following:



<pre class="wp-block-preformatted">./check_ncpa.py -H &lt;ncpaserver&gt; -t mytoken -M 'cpu/percent' -q 'aggregate=avg'</pre>



The above would output the following:



<pre class="wp-block-preformatted">OK: Percent was 2.16 % | 'percent'=2.16%;;;</pre>



If we removed the&nbsp;<code>-q 'aggregate=avg'</code>, which is passing arguments to the URL that the plugin is generating, we would get:



<pre class="wp-block-preformatted">OK: Percent was 7.70 %, 0.00 %, 11.10 %, 0.00 %, 0.00 %, 0.00 %, 3.00 %, 0.00 %, 0.00 %, 0.00 %, 0.00 %, 1.50 %, 0.00 %, 1.50 %, 0.00 %, 3.20 % | 'percent_0'=7.70%;;; 'percent_1'=0.00%;;; 'percent_2'=11.10%;;; 'percent_3'=0.00%;;; 'percent_4'=0.00%;;; 'percent_5'=0.00%;;; 'percent_6'=3.00%;;; 'percent_7'=0.00%;;; 'percent_8'=0.00%;;; 'percent_9'=0.00%;;; 'percent_10'=0.00%;;; 'percent_11'=1.50%;;; 'percent_12'=0.00%;;; 'percent_13'=1.50%;;; 'percent_14'=0.00%;;; 'percent_15'=3.20%;;;</pre>



This check represents an 8 core processor with 16 threads. You can see how it might be helpful to send these extra variables in your checks. If we were to define a warning and critical value above, it would apply to each of the threads instead of the check as a whole.



<h6 class="wp-block-heading">Running Plugins with Arguments</h6>



If you are using the&nbsp;<code>plugins</code>&nbsp;module to execute your own custom scripts, you will likely want to be able to pass arguments to the executed script. To do this, pass the&nbsp;<code>args</code>&nbsp;parameter.&nbsp;<code>check_ncpa.py</code>&nbsp;has&nbsp;<code>-q</code>, which allows you to pass parameters with the request.&nbsp;Make sure you quote the arguments right when you send them; single quotes and double quotes matter here.



If we had a script called&nbsp;<code>test.sh</code>, running it from the command line may look something like this:



<pre class="wp-block-preformatted">./test.sh -u 'one argument' -p 'another argument'</pre>



To run the above script using NCPA and the&nbsp;<code>check_ncpa.py</code>&nbsp;plugin:



<pre class="wp-block-preformatted">./check_ncpa.py -H &lt;ncpaserver&gt; -t mytoken -M 'plugins/test.sh' -q "args=-u 'one argument',args=-p 'another argument'"</pre>



The quotes matter for how the plugin is going to be interpreted by NCPA when it is ran. To see this clearly, check out these examples of how the plugin would create the API call for each quoting example:



<ul>
<li><a href="https://www.nagios.org/ncpa/help/3.0/active.html#with-quotes">With Quotes</a></li>



<li><a href="https://www.nagios.org/ncpa/help/3.0/active.html#without-quotes">Without Quotes</a></li>
</ul>



<pre class="wp-block-preformatted">./check_ncpa.py -H &lt;ncpaserver&gt; -t mytoken -M 'plugins/test.sh' -q "args=-u 'one argument',args=-p 'another argument'"</pre>



The above would give you the following URL:



<pre class="wp-block-preformatted">https://&lt;ncpaserver&gt;/api/plugins/test.sh?args=-u 'one argument'&amp;args=-p 'another argument'</pre>



<h2 class="wp-block-heading" id="anchor-Additional-Features-5">Additional Features</h2>



There are some special arguments that do not run checks that can be used to help test out using the plugin for a specific check.



<h6 class="wp-block-heading">Listing Available Nodes</h6>



You can also use&nbsp;<code>check_ncpa.py</code>&nbsp;to return a representation of all the values you can monitor in a specific API node. This can be very helpful when you are in a terminal without the use of a web browser. You can use the&nbsp;<code>--list</code>&nbsp;(or&nbsp;<code>-l</code>) command to have it list, rather than run a check, on a particular node:



<pre class="wp-block-preformatted">./check_ncpa.py -H &lt;ncpaserver&gt; -t mytoken -M 'disk' --list</pre>



The list command will also work with no specified&nbsp;<code>-M</code>&nbsp;and will list all the base modules available in the API.

test 4

Running active checks against NCPA is fairly straight-forward and follows a similar style as&nbsp;<code>check_nrpe</code>. You should download the latest version of the&nbsp;<a href="https://github.com/NagiosEnterprises/ncpa/blob/master/client/check_ncpa.py">check_ncpa.py plugin</a>&nbsp;&nbsp;from GitHub. This plugin works with NCPA 2+ and is backwards compatible with NCPA 1. This plugin is the standard method for executing active checks. However, because of the design of NCPA, it makes it&nbsp;very&nbsp;easy to use your own methods to collect data at perform active checks, even from a simple&nbsp;<code>curl</code>&nbsp;command. We will leave the choice to you, but we will support active checks through the&nbsp;<code>check_ncpa.py</code>&nbsp;plugin.



<blockquote class="wp-block-quote is-layout-flow wp-block-quote-is-layout-flow">
Note:&nbsp;All the examples in this page are from a Nagios server (either&nbsp;Nagios XI&nbsp;or&nbsp;Nagios Core) because the active checks are set up in Nagios and do not require any changes to be done in NCPA, besides setting up plugin directives or configuring how to access the API.
</blockquote>



Using the plugin will require some knowledge of how the API works. You will also need to make sure you install the plugin in the Nagios libexec (typically&nbsp;<code>/usr/local/nagios/libexec</code>) directory.



<blockquote class="wp-block-quote is-layout-flow wp-block-quote-is-layout-flow">
Tip:&nbsp;If you are using&nbsp;Nagios XI, you can skip installing the plugin manually. By default,&nbsp;Nagios XI&nbsp;comes with a config wizard for NCPA. You can check for updates by going to the&nbsp;Admin &gt; Manage Config Wizards&nbsp;page and clicking on&nbsp;Check for Updates. You can then click the&nbsp;install&nbsp;link in the NCPA config wizard table row to upgrade to the latest version if a new one is available. The config wizard upgrade script will install the latest version of the plugin for you.&nbsp;Running the config wizard is the fastest way to get started with NCPA active checks since it requires no manual configuration.
</blockquote>



<h2 class="wp-block-heading" id="anchor-Running-an-Active-Check-3">Running an Active Check</h2>



While you can run a check through the API in your browser, you will want to use the&nbsp;<code>check_ncpa.py</code>&nbsp;plugin to run these active checks from your Nagios server to have your results show up in Nagios. Once you&#8217;ve installed your plugin on the Nagios server in your&nbsp;<code>libexec</code>&nbsp;directory, you can run it just like any other plugin.



The most important part you&#8217;ll need to do is specify the API endpoint that you want to run the check on. This is done by passing the node endpoint (or as the plugin calls this value, the metric) by the&nbsp;<code>-M</code>&nbsp;argument.



<blockquote class="wp-block-quote is-layout-flow wp-block-quote-is-layout-flow">
Note:&nbsp;You will need to make sure to wrap any node endpoint that uses the&nbsp;<code>disk</code>&nbsp;module with single quotes. This is because NCPA uses the&nbsp;<code>|</code>&nbsp;character instead of slashes. This is to help with running values from URLs in the API. However, the pipe character is a special character in the linux shell and must be escaped by single quotes. Example:&nbsp;<code>-M 'disk/logical/C:|'</code>
</blockquote>



<h6 class="wp-block-heading">Example Check</h6>



A simple check to demonstrate how the plugin works is checking for the used memory percent:



<pre class="wp-block-preformatted">./check_ncpa.py -H &lt;ncpaserver&gt; -t mytoken -M 'memory/virtual/percent'</pre>



The above check will return the following:



<pre class="wp-block-preformatted">OK: Percent was 36.20 % | 'percent'=36.20%;;;</pre>



This is a pretty simple check &#8211; you can do a lot of tweaking to get different output. Read on in the&nbsp;<a href="https://www.nagios.org/ncpa/help/3.0/active.html#using-the-plugin">section that explains how to use the check_ncpa.py plugin</a>&nbsp;to see more options. Most of the base nodes, such as&nbsp;<code>memory/virtual</code>, have special checks that encompass all the child endpoints. You can see an example of that below.



<h6 class="wp-block-heading">Example Check and Specifying Units</h6>



Say we want to see the amount of memory we are using in GB, but NCPA returns the value in B by default. Typically we would add&nbsp;<code>units=G</code>&nbsp;in the API URL call, but the plugin will do this for us. See the example below:



<pre class="wp-block-preformatted">./check_ncpa.py -H &lt;ncpaserver&gt; -t mytoken -M 'memory/virtual/used' -u G</pre>



Will return the GB value instead of the B value:



<pre class="wp-block-preformatted">OK: Used was 13.16 GB | 'used'=13.16GB;;;</pre>







<h2 class="wp-block-heading" id="anchor-Using-the-check_ncpa.py-Plugin-3">Using the check_ncpa.py Plugin</h2>



In this section, we will cover some of the standard use cases and how to use the plugin to achieve specific output. While this section will go over most of the arguments that are available in the plugin, you can also view all the available arguments by using&nbsp;<code>--help</code>.



<blockquote class="wp-block-quote is-layout-flow wp-block-quote-is-layout-flow">
Note:&nbsp;If you encounter problems with the plugin, you can use the&nbsp;<code>-v</code>&nbsp;argument to enable verbose output of problems. There is also a&nbsp;<code>-D</code>&nbsp;argument that enables debugging output.
</blockquote>



<h6 class="wp-block-heading">Warning and Critical Values</h6>



You can send warning (<code>-w</code>&nbsp;or&nbsp;<code>--warning=</code>) and critical (<code>-c</code>&nbsp;or&nbsp;<code>--critical=</code>) values to any value that comes from the API nodes besides the&nbsp;<code>plugins</code>&nbsp;node since&nbsp;these values do not work with plugins. If you need to send the warning and critical values to your plugins,&nbsp;<a href="https://www.nagios.org/ncpa/help/3.0/active.html#plugins">you&#8217;ll have to pass them as plugin arguments</a>.



<pre class="wp-block-preformatted">./check_ncpa.py -H &lt;ncpaserver&gt; -t mytoken -M 'processes' --warning=100 --critical=200</pre>



The output would look something like this:



<pre class="wp-block-preformatted">WARNING: Process count was 177 | 'process_count'=177;100;200;</pre>



You can see that now the perfdata has the warning and critical values set. Also, we see that the system we are checking has over 100 processes and so it shows up as a warning.



<h6 class="wp-block-heading">Sending a Query String</h6>



You can send additional query string arguments in a&nbsp;comma separated list of&nbsp;<code>key=value</code>&nbsp;pairs. If we were interested in getting the CPU Usage (average percent over all cores) of the host that we installed NCPA on, we would run the&nbsp;<code>check_ncpa.py</code>&nbsp;with the&nbsp;<code>-q</code>&nbsp;argument because we need to tell NCPA how to aggregate the CPU usage results. The check would be the following:



<pre class="wp-block-preformatted">./check_ncpa.py -H &lt;ncpaserver&gt; -t mytoken -M 'cpu/percent' -q 'aggregate=avg'</pre>



The above would output the following:



<pre class="wp-block-preformatted">OK: Percent was 2.16 % | 'percent'=2.16%;;;</pre>



If we removed the&nbsp;<code>-q 'aggregate=avg'</code>, which is passing arguments to the URL that the plugin is generating, we would get:



<pre class="wp-block-preformatted">OK: Percent was 7.70 %, 0.00 %, 11.10 %, 0.00 %, 0.00 %, 0.00 %, 3.00 %, 0.00 %, 0.00 %, 0.00 %, 0.00 %, 1.50 %, 0.00 %, 1.50 %, 0.00 %, 3.20 % | 'percent_0'=7.70%;;; 'percent_1'=0.00%;;; 'percent_2'=11.10%;;; 'percent_3'=0.00%;;; 'percent_4'=0.00%;;; 'percent_5'=0.00%;;; 'percent_6'=3.00%;;; 'percent_7'=0.00%;;; 'percent_8'=0.00%;;; 'percent_9'=0.00%;;; 'percent_10'=0.00%;;; 'percent_11'=1.50%;;; 'percent_12'=0.00%;;; 'percent_13'=1.50%;;; 'percent_14'=0.00%;;; 'percent_15'=3.20%;;;</pre>



This check represents an 8 core processor with 16 threads. You can see how it might be helpful to send these extra variables in your checks. If we were to define a warning and critical value above, it would apply to each of the threads instead of the check as a whole.



<h6 class="wp-block-heading">Running Plugins with Arguments</h6>



If you are using the&nbsp;<code>plugins</code>&nbsp;module to execute your own custom scripts, you will likely want to be able to pass arguments to the executed script. To do this, pass the&nbsp;<code>args</code>&nbsp;parameter.&nbsp;<code>check_ncpa.py</code>&nbsp;has&nbsp;<code>-q</code>, which allows you to pass parameters with the request.&nbsp;Make sure you quote the arguments right when you send them; single quotes and double quotes matter here.



If we had a script called&nbsp;<code>test.sh</code>, running it from the command line may look something like this:



<pre class="wp-block-preformatted">./test.sh -u 'one argument' -p 'another argument'</pre>



To run the above script using NCPA and the&nbsp;<code>check_ncpa.py</code>&nbsp;plugin:



<pre class="wp-block-preformatted">./check_ncpa.py -H &lt;ncpaserver&gt; -t mytoken -M 'plugins/test.sh' -q "args=-u 'one argument',args=-p 'another argument'"</pre>



The quotes matter for how the plugin is going to be interpreted by NCPA when it is ran. To see this clearly, check out these examples of how the plugin would create the API call for each quoting example:



<ul>
<li><a href="https://www.nagios.org/ncpa/help/3.0/active.html#with-quotes">With Quotes</a></li>



<li><a href="https://www.nagios.org/ncpa/help/3.0/active.html#without-quotes">Without Quotes</a></li>
</ul>



<pre class="wp-block-preformatted">./check_ncpa.py -H &lt;ncpaserver&gt; -t mytoken -M 'plugins/test.sh' -q "args=-u 'one argument',args=-p 'another argument'"</pre>



The above would give you the following URL:



<pre class="wp-block-preformatted">https://&lt;ncpaserver&gt;/api/plugins/test.sh?args=-u 'one argument'&amp;args=-p 'another argument'</pre>



<h2 class="wp-block-heading" id="anchor-Additional-Features-3">Additional Features</h2>



There are some special arguments that do not run checks that can be used to help test out using the plugin for a specific check.



<h6 class="wp-block-heading">Listing Available Nodes</h6>



You can also use&nbsp;<code>check_ncpa.py</code>&nbsp;to return a representation of all the values you can monitor in a specific API node. This can be very helpful when you are in a terminal without the use of a web browser. You can use the&nbsp;<code>--list</code>&nbsp;(or&nbsp;<code>-l</code>) command to have it list, rather than run a check, on a particular node:



<pre class="wp-block-preformatted">./check_ncpa.py -H &lt;ncpaserver&gt; -t mytoken -M 'disk' --list</pre>



The list command will also work with no specified&nbsp;<code>-M</code>&nbsp;and will list all the base modules available in the API.

test 3

Running active checks against NCPA is fairly straight-forward and follows a similar style as&nbsp;<code>check_nrpe</code>. You should download the latest version of the&nbsp;<a href="https://github.com/NagiosEnterprises/ncpa/blob/master/client/check_ncpa.py">check_ncpa.py plugin</a>&nbsp;&nbsp;from GitHub. This plugin works with NCPA 2+ and is backwards compatible with NCPA 1. This plugin is the standard method for executing active checks. However, because of the design of NCPA, it makes it&nbsp;very&nbsp;easy to use your own methods to collect data at perform active checks, even from a simple&nbsp;<code>curl</code>&nbsp;command. We will leave the choice to you, but we will support active checks through the&nbsp;<code>check_ncpa.py</code>&nbsp;plugin.



<blockquote class="wp-block-quote is-layout-flow wp-block-quote-is-layout-flow">
Note:&nbsp;All the examples in this page are from a Nagios server (either&nbsp;Nagios XI&nbsp;or&nbsp;Nagios Core) because the active checks are set up in Nagios and do not require any changes to be done in NCPA, besides setting up plugin directives or configuring how to access the API.
</blockquote>



Using the plugin will require some knowledge of how the API works. You will also need to make sure you install the plugin in the Nagios libexec (typically&nbsp;<code>/usr/local/nagios/libexec</code>) directory.



<blockquote class="wp-block-quote is-layout-flow wp-block-quote-is-layout-flow">
Tip:&nbsp;If you are using&nbsp;Nagios XI, you can skip installing the plugin manually. By default,&nbsp;Nagios XI&nbsp;comes with a config wizard for NCPA. You can check for updates by going to the&nbsp;Admin &gt; Manage Config Wizards&nbsp;page and clicking on&nbsp;Check for Updates. You can then click the&nbsp;install&nbsp;link in the NCPA config wizard table row to upgrade to the latest version if a new one is available. The config wizard upgrade script will install the latest version of the plugin for you.&nbsp;Running the config wizard is the fastest way to get started with NCPA active checks since it requires no manual configuration.
</blockquote>



<h2 class="wp-block-heading" id="anchor-Running-an-Active-Check">Running an Active Check</h2>



While you can run a check through the API in your browser, you will want to use the&nbsp;<code>check_ncpa.py</code>&nbsp;plugin to run these active checks from your Nagios server to have your results show up in Nagios. Once you&#8217;ve installed your plugin on the Nagios server in your&nbsp;<code>libexec</code>&nbsp;directory, you can run it just like any other plugin.



The most important part you&#8217;ll need to do is specify the API endpoint that you want to run the check on. This is done by passing the node endpoint (or as the plugin calls this value, the metric) by the&nbsp;<code>-M</code>&nbsp;argument.



<blockquote class="wp-block-quote is-layout-flow wp-block-quote-is-layout-flow">
Note:&nbsp;You will need to make sure to wrap any node endpoint that uses the&nbsp;<code>disk</code>&nbsp;module with single quotes. This is because NCPA uses the&nbsp;<code>|</code>&nbsp;character instead of slashes. This is to help with running values from URLs in the API. However, the pipe character is a special character in the linux shell and must be escaped by single quotes. Example:&nbsp;<code>-M 'disk/logical/C:|'</code>
</blockquote>



<h6 class="wp-block-heading">Example Check</h6>



A simple check to demonstrate how the plugin works is checking for the used memory percent:



<pre class="wp-block-preformatted">./check_ncpa.py -H &lt;ncpaserver&gt; -t mytoken -M 'memory/virtual/percent'</pre>



The above check will return the following:



<pre class="wp-block-preformatted">OK: Percent was 36.20 % | 'percent'=36.20%;;;</pre>



This is a pretty simple check &#8211; you can do a lot of tweaking to get different output. Read on in the&nbsp;<a href="https://www.nagios.org/ncpa/help/3.0/active.html#using-the-plugin">section that explains how to use the check_ncpa.py plugin</a>&nbsp;to see more options. Most of the base nodes, such as&nbsp;<code>memory/virtual</code>, have special checks that encompass all the child endpoints. You can see an example of that below.



<h6 class="wp-block-heading">Example Check and Specifying Units</h6>



Say we want to see the amount of memory we are using in GB, but NCPA returns the value in B by default. Typically we would add&nbsp;<code>units=G</code>&nbsp;in the API URL call, but the plugin will do this for us. See the example below:



<pre class="wp-block-preformatted">./check_ncpa.py -H &lt;ncpaserver&gt; -t mytoken -M 'memory/virtual/used' -u G</pre>



Will return the GB value instead of the B value:



<pre class="wp-block-preformatted">OK: Used was 13.16 GB | 'used'=13.16GB;;;</pre>







<h2 class="wp-block-heading" id="anchor-Using-the-check_ncpa.py-Plugin">Using the check_ncpa.py Plugin</h2>



In this section, we will cover some of the standard use cases and how to use the plugin to achieve specific output. While this section will go over most of the arguments that are available in the plugin, you can also view all the available arguments by using&nbsp;<code>--help</code>.



<blockquote class="wp-block-quote is-layout-flow wp-block-quote-is-layout-flow">
Note:&nbsp;If you encounter problems with the plugin, you can use the&nbsp;<code>-v</code>&nbsp;argument to enable verbose output of problems. There is also a&nbsp;<code>-D</code>&nbsp;argument that enables debugging output.
</blockquote>



<h6 class="wp-block-heading">Warning and Critical Values</h6>



You can send warning (<code>-w</code>&nbsp;or&nbsp;<code>--warning=</code>) and critical (<code>-c</code>&nbsp;or&nbsp;<code>--critical=</code>) values to any value that comes from the API nodes besides the&nbsp;<code>plugins</code>&nbsp;node since&nbsp;these values do not work with plugins. If you need to send the warning and critical values to your plugins,&nbsp;<a href="https://www.nagios.org/ncpa/help/3.0/active.html#plugins">you&#8217;ll have to pass them as plugin arguments</a>.



<pre class="wp-block-preformatted">./check_ncpa.py -H &lt;ncpaserver&gt; -t mytoken -M 'processes' --warning=100 --critical=200</pre>



The output would look something like this:



<pre class="wp-block-preformatted">WARNING: Process count was 177 | 'process_count'=177;100;200;</pre>



You can see that now the perfdata has the warning and critical values set. Also, we see that the system we are checking has over 100 processes and so it shows up as a warning.



<h6 class="wp-block-heading">Sending a Query String</h6>



You can send additional query string arguments in a&nbsp;comma separated list of&nbsp;<code>key=value</code>&nbsp;pairs. If we were interested in getting the CPU Usage (average percent over all cores) of the host that we installed NCPA on, we would run the&nbsp;<code>check_ncpa.py</code>&nbsp;with the&nbsp;<code>-q</code>&nbsp;argument because we need to tell NCPA how to aggregate the CPU usage results. The check would be the following:



<pre class="wp-block-preformatted">./check_ncpa.py -H &lt;ncpaserver&gt; -t mytoken -M 'cpu/percent' -q 'aggregate=avg'</pre>



The above would output the following:



<pre class="wp-block-preformatted">OK: Percent was 2.16 % | 'percent'=2.16%;;;</pre>



If we removed the&nbsp;<code>-q 'aggregate=avg'</code>, which is passing arguments to the URL that the plugin is generating, we would get:



<pre class="wp-block-preformatted">OK: Percent was 7.70 %, 0.00 %, 11.10 %, 0.00 %, 0.00 %, 0.00 %, 3.00 %, 0.00 %, 0.00 %, 0.00 %, 0.00 %, 1.50 %, 0.00 %, 1.50 %, 0.00 %, 3.20 % | 'percent_0'=7.70%;;; 'percent_1'=0.00%;;; 'percent_2'=11.10%;;; 'percent_3'=0.00%;;; 'percent_4'=0.00%;;; 'percent_5'=0.00%;;; 'percent_6'=3.00%;;; 'percent_7'=0.00%;;; 'percent_8'=0.00%;;; 'percent_9'=0.00%;;; 'percent_10'=0.00%;;; 'percent_11'=1.50%;;; 'percent_12'=0.00%;;; 'percent_13'=1.50%;;; 'percent_14'=0.00%;;; 'percent_15'=3.20%;;;</pre>



This check represents an 8 core processor with 16 threads. You can see how it might be helpful to send these extra variables in your checks. If we were to define a warning and critical value above, it would apply to each of the threads instead of the check as a whole.



<h6 class="wp-block-heading">Running Plugins with Arguments</h6>



If you are using the&nbsp;<code>plugins</code>&nbsp;module to execute your own custom scripts, you will likely want to be able to pass arguments to the executed script. To do this, pass the&nbsp;<code>args</code>&nbsp;parameter.&nbsp;<code>check_ncpa.py</code>&nbsp;has&nbsp;<code>-q</code>, which allows you to pass parameters with the request.&nbsp;Make sure you quote the arguments right when you send them; single quotes and double quotes matter here.



If we had a script called&nbsp;<code>test.sh</code>, running it from the command line may look something like this:



<pre class="wp-block-preformatted">./test.sh -u 'one argument' -p 'another argument'</pre>



To run the above script using NCPA and the&nbsp;<code>check_ncpa.py</code>&nbsp;plugin:



<pre class="wp-block-preformatted">./check_ncpa.py -H &lt;ncpaserver&gt; -t mytoken -M 'plugins/test.sh' -q "args=-u 'one argument',args=-p 'another argument'"</pre>



The quotes matter for how the plugin is going to be interpreted by NCPA when it is ran. To see this clearly, check out these examples of how the plugin would create the API call for each quoting example:



<ul>
<li><a href="https://www.nagios.org/ncpa/help/3.0/active.html#with-quotes">With Quotes</a></li>



<li><a href="https://www.nagios.org/ncpa/help/3.0/active.html#without-quotes">Without Quotes</a></li>
</ul>



<pre class="wp-block-preformatted">./check_ncpa.py -H &lt;ncpaserver&gt; -t mytoken -M 'plugins/test.sh' -q "args=-u 'one argument',args=-p 'another argument'"</pre>



The above would give you the following URL:



<pre class="wp-block-preformatted">https://&lt;ncpaserver&gt;/api/plugins/test.sh?args=-u 'one argument'&amp;args=-p 'another argument'</pre>



<h2 class="wp-block-heading" id="anchor-Additional-Features">Additional Features</h2>



There are some special arguments that do not run checks that can be used to help test out using the plugin for a specific check.



<h6 class="wp-block-heading">Listing Available Nodes</h6>



You can also use&nbsp;<code>check_ncpa.py</code>&nbsp;to return a representation of all the values you can monitor in a specific API node. This can be very helpful when you are in a terminal without the use of a web browser. You can use the&nbsp;<code>--list</code>&nbsp;(or&nbsp;<code>-l</code>) command to have it list, rather than run a check, on a particular node:



<pre class="wp-block-preformatted">./check_ncpa.py -H &lt;ncpaserver&gt; -t mytoken -M 'disk' --list</pre>



The list command will also work with no specified&nbsp;<code>-M</code>&nbsp;and will list all the base modules available in the API.

test 1

Running active checks against NCPA is fairly straight-forward and follows a similar style as&nbsp;<code>check_nrpe</code>. You should download the latest version of the&nbsp;<a href="https://github.com/NagiosEnterprises/ncpa/blob/master/client/check_ncpa.py">check_ncpa.py plugin</a>&nbsp;&nbsp;from GitHub. This plugin works with NCPA 2+ and is backwards compatible with NCPA 1. This plugin is the standard method for executing active checks. However, because of the design of NCPA, it makes it&nbsp;very&nbsp;easy to use your own methods to collect data at perform active checks, even from a simple&nbsp;<code>curl</code>&nbsp;command. We will leave the choice to you, but we will support active checks through the&nbsp;<code>check_ncpa.py</code>&nbsp;plugin.



<blockquote class="wp-block-quote is-layout-flow wp-block-quote-is-layout-flow">
Note:&nbsp;All the examples in this page are from a Nagios server (either&nbsp;Nagios XI&nbsp;or&nbsp;Nagios Core) because the active checks are set up in Nagios and do not require any changes to be done in NCPA, besides setting up plugin directives or configuring how to access the API.
</blockquote>



Using the plugin will require some knowledge of how the API works. You will also need to make sure you install the plugin in the Nagios libexec (typically&nbsp;<code>/usr/local/nagios/libexec</code>) directory.



<blockquote class="wp-block-quote is-layout-flow wp-block-quote-is-layout-flow">
Tip:&nbsp;If you are using&nbsp;Nagios XI, you can skip installing the plugin manually. By default,&nbsp;Nagios XI&nbsp;comes with a config wizard for NCPA. You can check for updates by going to the&nbsp;Admin &gt; Manage Config Wizards&nbsp;page and clicking on&nbsp;Check for Updates. You can then click the&nbsp;install&nbsp;link in the NCPA config wizard table row to upgrade to the latest version if a new one is available. The config wizard upgrade script will install the latest version of the plugin for you.&nbsp;Running the config wizard is the fastest way to get started with NCPA active checks since it requires no manual configuration.
</blockquote>



<h2 class="wp-block-heading" id="anchor-Running-an-Active-Check-4">Running an Active Check</h2>



While you can run a check through the API in your browser, you will want to use the&nbsp;<code>check_ncpa.py</code>&nbsp;plugin to run these active checks from your Nagios server to have your results show up in Nagios. Once you&#8217;ve installed your plugin on the Nagios server in your&nbsp;<code>libexec</code>&nbsp;directory, you can run it just like any other plugin.



The most important part you&#8217;ll need to do is specify the API endpoint that you want to run the check on. This is done by passing the node endpoint (or as the plugin calls this value, the metric) by the&nbsp;<code>-M</code>&nbsp;argument.



<blockquote class="wp-block-quote is-layout-flow wp-block-quote-is-layout-flow">
Note:&nbsp;You will need to make sure to wrap any node endpoint that uses the&nbsp;<code>disk</code>&nbsp;module with single quotes. This is because NCPA uses the&nbsp;<code>|</code>&nbsp;character instead of slashes. This is to help with running values from URLs in the API. However, the pipe character is a special character in the linux shell and must be escaped by single quotes. Example:&nbsp;<code>-M 'disk/logical/C:|'</code>
</blockquote>



<h6 class="wp-block-heading">Example Check</h6>



A simple check to demonstrate how the plugin works is checking for the used memory percent:



<pre class="wp-block-preformatted">./check_ncpa.py -H &lt;ncpaserver&gt; -t mytoken -M 'memory/virtual/percent'</pre>



The above check will return the following:



<pre class="wp-block-preformatted">OK: Percent was 36.20 % | 'percent'=36.20%;;;</pre>



This is a pretty simple check &#8211; you can do a lot of tweaking to get different output. Read on in the&nbsp;<a href="https://www.nagios.org/ncpa/help/3.0/active.html#using-the-plugin">section that explains how to use the check_ncpa.py plugin</a>&nbsp;to see more options. Most of the base nodes, such as&nbsp;<code>memory/virtual</code>, have special checks that encompass all the child endpoints. You can see an example of that below.



<h6 class="wp-block-heading">Example Check and Specifying Units</h6>



Say we want to see the amount of memory we are using in GB, but NCPA returns the value in B by default. Typically we would add&nbsp;<code>units=G</code>&nbsp;in the API URL call, but the plugin will do this for us. See the example below:



<pre class="wp-block-preformatted">./check_ncpa.py -H &lt;ncpaserver&gt; -t mytoken -M 'memory/virtual/used' -u G</pre>



Will return the GB value instead of the B value:



<pre class="wp-block-preformatted">OK: Used was 13.16 GB | 'used'=13.16GB;;;</pre>







<h2 class="wp-block-heading" id="anchor-Using-the-check_ncpa.py-Plugin-4">Using the check_ncpa.py Plugin</h2>



In this section, we will cover some of the standard use cases and how to use the plugin to achieve specific output. While this section will go over most of the arguments that are available in the plugin, you can also view all the available arguments by using&nbsp;<code>--help</code>.



<blockquote class="wp-block-quote is-layout-flow wp-block-quote-is-layout-flow">
Note:&nbsp;If you encounter problems with the plugin, you can use the&nbsp;<code>-v</code>&nbsp;argument to enable verbose output of problems. There is also a&nbsp;<code>-D</code>&nbsp;argument that enables debugging output.
</blockquote>



<h6 class="wp-block-heading">Warning and Critical Values</h6>



You can send warning (<code>-w</code>&nbsp;or&nbsp;<code>--warning=</code>) and critical (<code>-c</code>&nbsp;or&nbsp;<code>--critical=</code>) values to any value that comes from the API nodes besides the&nbsp;<code>plugins</code>&nbsp;node since&nbsp;these values do not work with plugins. If you need to send the warning and critical values to your plugins,&nbsp;<a href="https://www.nagios.org/ncpa/help/3.0/active.html#plugins">you&#8217;ll have to pass them as plugin arguments</a>.



<pre class="wp-block-preformatted">./check_ncpa.py -H &lt;ncpaserver&gt; -t mytoken -M 'processes' --warning=100 --critical=200</pre>



The output would look something like this:



<pre class="wp-block-preformatted">WARNING: Process count was 177 | 'process_count'=177;100;200;</pre>



You can see that now the perfdata has the warning and critical values set. Also, we see that the system we are checking has over 100 processes and so it shows up as a warning.



<h6 class="wp-block-heading">Sending a Query String</h6>



You can send additional query string arguments in a&nbsp;comma separated list of&nbsp;<code>key=value</code>&nbsp;pairs. If we were interested in getting the CPU Usage (average percent over all cores) of the host that we installed NCPA on, we would run the&nbsp;<code>check_ncpa.py</code>&nbsp;with the&nbsp;<code>-q</code>&nbsp;argument because we need to tell NCPA how to aggregate the CPU usage results. The check would be the following:



<pre class="wp-block-preformatted">./check_ncpa.py -H &lt;ncpaserver&gt; -t mytoken -M 'cpu/percent' -q 'aggregate=avg'</pre>



The above would output the following:



<pre class="wp-block-preformatted">OK: Percent was 2.16 % | 'percent'=2.16%;;;</pre>



If we removed the&nbsp;<code>-q 'aggregate=avg'</code>, which is passing arguments to the URL that the plugin is generating, we would get:



<pre class="wp-block-preformatted">OK: Percent was 7.70 %, 0.00 %, 11.10 %, 0.00 %, 0.00 %, 0.00 %, 3.00 %, 0.00 %, 0.00 %, 0.00 %, 0.00 %, 1.50 %, 0.00 %, 1.50 %, 0.00 %, 3.20 % | 'percent_0'=7.70%;;; 'percent_1'=0.00%;;; 'percent_2'=11.10%;;; 'percent_3'=0.00%;;; 'percent_4'=0.00%;;; 'percent_5'=0.00%;;; 'percent_6'=3.00%;;; 'percent_7'=0.00%;;; 'percent_8'=0.00%;;; 'percent_9'=0.00%;;; 'percent_10'=0.00%;;; 'percent_11'=1.50%;;; 'percent_12'=0.00%;;; 'percent_13'=1.50%;;; 'percent_14'=0.00%;;; 'percent_15'=3.20%;;;</pre>



This check represents an 8 core processor with 16 threads. You can see how it might be helpful to send these extra variables in your checks. If we were to define a warning and critical value above, it would apply to each of the threads instead of the check as a whole.



<h6 class="wp-block-heading">Running Plugins with Arguments</h6>



If you are using the&nbsp;<code>plugins</code>&nbsp;module to execute your own custom scripts, you will likely want to be able to pass arguments to the executed script. To do this, pass the&nbsp;<code>args</code>&nbsp;parameter.&nbsp;<code>check_ncpa.py</code>&nbsp;has&nbsp;<code>-q</code>, which allows you to pass parameters with the request.&nbsp;Make sure you quote the arguments right when you send them; single quotes and double quotes matter here.



If we had a script called&nbsp;<code>test.sh</code>, running it from the command line may look something like this:



<pre class="wp-block-preformatted">./test.sh -u 'one argument' -p 'another argument'</pre>



To run the above script using NCPA and the&nbsp;<code>check_ncpa.py</code>&nbsp;plugin:



<pre class="wp-block-preformatted">./check_ncpa.py -H &lt;ncpaserver&gt; -t mytoken -M 'plugins/test.sh' -q "args=-u 'one argument',args=-p 'another argument'"</pre>



The quotes matter for how the plugin is going to be interpreted by NCPA when it is ran. To see this clearly, check out these examples of how the plugin would create the API call for each quoting example:



<ul>
<li><a href="https://www.nagios.org/ncpa/help/3.0/active.html#with-quotes">With Quotes</a></li>



<li><a href="https://www.nagios.org/ncpa/help/3.0/active.html#without-quotes">Without Quotes</a></li>
</ul>



<pre class="wp-block-preformatted">./check_ncpa.py -H &lt;ncpaserver&gt; -t mytoken -M 'plugins/test.sh' -q "args=-u 'one argument',args=-p 'another argument'"</pre>



The above would give you the following URL:



<pre class="wp-block-preformatted">https://&lt;ncpaserver&gt;/api/plugins/test.sh?args=-u 'one argument'&amp;args=-p 'another argument'</pre>



<h2 class="wp-block-heading" id="anchor-Additional-Features-4">Additional Features</h2>



There are some special arguments that do not run checks that can be used to help test out using the plugin for a specific check.



<h6 class="wp-block-heading">Listing Available Nodes</h6>



You can also use&nbsp;<code>check_ncpa.py</code>&nbsp;to return a representation of all the values you can monitor in a specific API node. This can be very helpful when you are in a terminal without the use of a web browser. You can use the&nbsp;<code>--list</code>&nbsp;(or&nbsp;<code>-l</code>) command to have it list, rather than run a check, on a particular node:



<pre class="wp-block-preformatted">./check_ncpa.py -H &lt;ncpaserver&gt; -t mytoken -M 'disk' --list</pre>



The list command will also work with no specified&nbsp;<code>-M</code>&nbsp;and will list all the base modules available in the API.

test 2

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed nec euismod neque. Aenean ultricies lobortis lorem ac viverra. Sed at luctus mi, eu convallis elit. Fusce laoreet, ligula sodales aliquam pulvinar, ex ante sollicitudin enim, non pellentesque ante ipsum sit amet massa. Ut consequat, velit et mattis semper, augue mauris mollis ligula, vitae molestie arcu dui quis ante. Mauris consectetur velit eget nulla porttitor pellentesque. Cras rutrum fringilla nulla non iaculis. Pellentesque bibendum, felis quis imperdiet dignissim, lectus orci fermentum lorem, a eleifend mauris ex at velit. Sed ut pharetra magna. Suspendisse potenti. Curabitur auctor fringilla turpis, eget luctus leo ullamcorper vel.



Vivamus at urna velit. In hac habitasse platea dictumst. Curabitur suscipit semper nulla eget aliquet. Pellentesque pulvinar gravida felis ut lobortis. Praesent feugiat lectus diam, placerat feugiat massa pellentesque et. Sed non tempus est, sed semper urna. Phasellus vulputate lectus quis nisl pulvinar vestibulum. Vestibulum et ex felis. Sed sodales laoreet enim, sed blandit est venenatis ut. Aenean sed velit eu est malesuada vulputate tempor eu justo.



Vestibulum consequat leo lorem, rutrum condimentum diam faucibus quis. Suspendisse faucibus cursus sapien, et aliquet tellus tempor nec. Aenean at dapibus arcu. Fusce lectus est, placerat sit amet lobortis sit amet, facilisis ac enim. Morbi molestie consectetur elit ac accumsan. Vestibulum ultrices sit amet massa vitae pellentesque. Cras auctor velit ac vehicula sagittis. Donec iaculis condimentum porta. Curabitur eleifend, dui vitae commodo eleifend, diam erat euismod ex, ultrices aliquam urna elit et massa.



Proin eleifend imperdiet ante, sit amet pellentesque lorem rutrum sed. Aenean ut nunc mauris. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis ligula mi, fringilla non turpis in, vehicula scelerisque orci. Nullam velit quam, posuere eget congue sed, rhoncus quis nunc. Maecenas sollicitudin elementum nisi, rutrum porttitor quam pellentesque ut. Duis nec odio vel leo feugiat cursus vel quis risus. Donec et enim eget risus eleifend dictum ut at nisl. Nulla facilisi. Nam et lacus porta purus rutrum gravida. Curabitur aliquet, turpis congue sagittis suscipit, nisl metus hendrerit felis, a interdum ipsum diam non ipsum.



Donec feugiat fermentum tortor in dapibus. Duis vestibulum est orci, nec luctus diam viverra vitae. Etiam neque dui, faucibus a fringilla ac, iaculis id massa. Suspendisse lacinia dignissim dui id feugiat. Cras eu mattis lectus. Nam pretium lobortis ullamcorper. Vestibulum commodo, est in malesuada hendrerit, lorem nisi bibendum leo, vel sagittis diam ligula ac arcu. Ut ac magna a enim blandit faucibus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Integer laoreet ullamcorper quam interdum convallis. Ut ultrices vulputate dui pellentesque porta. Aenean at consectetur magna. Pellentesque vitae quam enim. Praesent dignissim ligula at nulla pulvinar, quis ultricies leo dignissim.