Difference between revisions of "ZenPack:TrueNAS"

From Zenoss Wiki
Jump to: navigation, search
Line 11: Line 11:
 
|Tag=c2de66db6814108dca2a19b3c1ed7a73588f7bbf
 
|Tag=c2de66db6814108dca2a19b3c1ed7a73588f7bbf
 
|Compatible with=Zenoss Core 4.2.x, Zenoss Core 5.0.x
 
|Compatible with=Zenoss Core 4.2.x, Zenoss Core 5.0.x
 +
|Requires=PyYAML,
 
}}
 
}}
 
|Devices=
 
|Devices=
Line 21: Line 22:
 
}}
 
}}
 
==Notes==
 
==Notes==
This ZenPack relies on SNMP to extract performance metrics as well as discovering pools and datasets.Therefore, the correct community has to be set. Apart from SNMP-based monitoring, FreeNAS events are also translated to Zenoss events. Dismissing them on FreeNAS, clears them on Zenoss.
+
This ZenPack relies on SNMP to extract performance metrics as well as discovering pools and datasets.Therefore, the correct community has to be set. Apart from SNMP-based monitoring, FreeNAS/TrueNAS events are also translated to Zenoss events. Dismissing them on the web interface clears them on Zenoss.
 
Syslog monitoring can also be enabled on the web interface regardless of this ZenPack's installation.
 
Syslog monitoring can also be enabled on the web interface regardless of this ZenPack's installation.
 
==Usage==
 
==Usage==
The ZenPack provides a device class named TrueNAS nested under /Server/Linux. All you have to do is adding a device and set its class to /Server/Linux/TrueNAS.
+
Before installing the ZenPack, be sure to install PyYAML as the Zenoss user:
There are a few other configuration properties to modify. all of them have the prefix zFreeNAS. Here's what you might want to change:
+
    easy_install PyYAML
zFreeNASLogin: FreeNAS web login. Used to extract alerts from the API
+
The ZenPack provides a device class named TrueNAS nested under /Server/Linux. FreeNAS/TrueNAS devices should be added to that class, configured then modelled.
zFreeNASPass: FreeNAS web password. Used to extract alerts from the API
+
Below a list of zProperties added by the ZenPack.
zFreeNASIgnorePools: List of pools to ignore on modeling. This list can be modified
+
 
zFreeNASIgnoreDatasets: List of pools to ignore on modeling. This list can be modified
+
{|class="wikitable"
 +
|-
 +
!zProperty
 +
!Description
 +
|-
 +
|zTrueNASLogin
 +
|FreeNAS/TrueNAS web login. Used to extract alerts from the API
 +
|-
 +
|zTrueNASPass
 +
|FreeNAS/TrueNAS web password. Used to extract alerts from the API
 +
|-
 +
|zFreeNASIgnorePools
 +
|List of pools to ignore on modeling.
 +
|-
 +
|zTrueNASIgnoreDatasets
 +
|List of datasets to ignore on modeling.
 +
|-
 +
|}
 
{{ZenPackFooter}}
 
{{ZenPackFooter}}

Revision as of 20:40, 6 November 2015

Author(s)
f.noushi
Current Maintainer(s)
f.noushi
Organization
iXsystems
License
GNU General Public License, Version 2, or later
ZenPack name
ZenPacks.iXsystems.TrueNAS
Git sources (for cloning)
Link


Applications Monitored: 



TrueNAS ZenPack

Monitoring of FreeNAS/TrueNAS servers with auto-discovery feature for pools and datasets

Warning

The ZenPack Catalog has moved to its new home at https://www.zenoss.com/product/zenpacks as of January 17, 2017. The following information may be out of date, and this page will eventually be removed.

Support

This ZenPack is developed by the Zenoss user community and supported via our online forums. Zenoss, Inc. does not provide direct support for this ZenPack.

Releases

Version 0.9.0- Download
Requires PyYAML ZenPack
Compatible with Zenoss Core 4.2.x, Zenoss Core 5.0.x

Background

Notes

This ZenPack relies on SNMP to extract performance metrics as well as discovering pools and datasets.Therefore, the correct community has to be set. Apart from SNMP-based monitoring, FreeNAS/TrueNAS events are also translated to Zenoss events. Dismissing them on the web interface clears them on Zenoss. Syslog monitoring can also be enabled on the web interface regardless of this ZenPack's installation.

Usage

Before installing the ZenPack, be sure to install PyYAML as the Zenoss user:

   easy_install PyYAML

The ZenPack provides a device class named TrueNAS nested under /Server/Linux. FreeNAS/TrueNAS devices should be added to that class, configured then modelled. Below a list of zProperties added by the ZenPack.

zProperty Description
zTrueNASLogin FreeNAS/TrueNAS web login. Used to extract alerts from the API
zTrueNASPass FreeNAS/TrueNAS web password. Used to extract alerts from the API
zFreeNASIgnorePools List of pools to ignore on modeling.
zTrueNASIgnoreDatasets List of datasets to ignore on modeling.

Installation

Normal Installation (packaged egg)

  1. Download the appropriate egg file for the version of Zenoss you are running.
  2. Ensure you are logged in as the zenoss user:
    $ sudo su - zenoss
  3. Install the ZenPack:
    $ zenpack --install ZenPacks.iXsystems.TrueNAS-*.egg
  4. Restart these services:
    $ zenoss restart

Developer Mode Installation

In order to do a development mode installation you will want to clone the existing git repository, and then use the --link flag with the zenpack command:

  1. Ensure you are logged in as the zenoss user:
    $ sudo su - zenoss
  2. Start by cloning the upstream repository:
    $ git clone https://github.com/N-faycal/ZenPacks.iXsystems.TrueNAS.git
  3. Next, perform the installation:
    $ zenpack --link --install ZenPacks.iXsystems.TrueNAS
  4. Finally, restart these serivices:
    $ zenoss restart

Discuss

Purplemarker.png New: Don't forget to add yourself to the Zenoss User Map!

blog comments powered by Disqus