Difference between revisions of "ZenPack:AIX"

From Zenoss Wiki
Jump to: navigation, search
m (Chet Luther moved page ZenPack:AIX Monitor to ZenPack:AIX: Consistency with other ZenPack names.)
Line 13: Line 13:
 
|Version=6.1
 
|Version=6.1
 
}}
 
}}
 +
|Integrations=
 +
|DataAudits=
 
|Binaries=
 
|Binaries=
 
|Flavor=commercial
 
|Flavor=commercial
 
}}
 
}}
The AIX Monitor ZenPack enables Resource Manager to use Secure Shell (SSH) to monitor AIX hosts. Resource Manager models and monitors devices placed in the <tt>/Server/SSH/AIX</tt> device class by running commands and parsing the output. Parsing of command output is performed on the Resource Manager server or on a distributed collector. The account used to monitor the device does not require root access or special privileges.
+
The <span class="zenpack">ZenPacks.zenoss.AixMonitor</span> ZenPack uses Secure Shell (SSH) to monitor AIX hosts.
Specifically, the AIX Monitor ZenPack provides:
+
 
 +
 
 +
This ZenPack models and monitors devices placed in the <span class="ph filepath">/Server/SSH/AIX</span> device class by running commands and parsing the output. The account used to monitor the device does not require root access or special privileges.
 +
 
 +
This ZenPack provides:
  
 
* File system and process monitoring
 
* File system and process monitoring
Line 25: Line 31:
 
* OS information (OS level command style information)
 
* OS information (OS level command style information)
 
* LPP and RPM information (such as installed software)
 
* LPP and RPM information (such as installed software)
 +
 +
 +
== Prerequisites ==
 +
 +
 +
{| class="wikitable"
 +
!width="50%"|Prerequisite
 +
!width="50%"|Restriction
 +
|-
 +
|Product
 +
|<span class="ph">Zenoss platform</span> 4.x
 +
|-
 +
|Required ZenPacks
 +
|ZenPacks.zenoss.AixMonitor
 +
|-
 +
|AIX Releases Supported
 +
|5.3 and 6.1
 +
|}
 +
 +
 +
<span class="notetitle">Note:</span>
 +
If using a distributed collector setup, SSH requires firewall access (default of port 22) from the collector to the monitored server.
 +
 +
 +
== Add an AIX Server ==
 +
 +
 +
The following procedure assumes that the credentials have been set.
 +
 +
 +
<ol>
 +
<li>From Infrastructure > Devices, select Add a Single Device.
 +
</li>
 +
<li>Enter the following information in the dialog:
 +
 +
 +
{| class="wikitable"
 +
|+ <span class="tablecap"><span class="tablecap">Adding AIX Device Information</span></span>
 +
!width="50%"|Name
 +
!width="50%"|Description
 +
|-
 +
|Name or IP
 +
 +
|AIX host to model
 +
 +
|-
 +
|Device Class
 +
 +
|<span class="ph filepath">/Server/SSH/AIX</span>
 +
 +
|-
 +
|Model Device
 +
 +
|Select this option unless adding a device with username/password different than found in the device class. If you do not select this option, then you must add the credentials, and then manually model the device.
 +
 +
|}
 +
 +
 +
</li>
 +
<li>Click '''Add Device''' to add the device.
 +
</li></ol>
 +
 +
 +
== Set AIX Server Monitoring Credentials ==
 +
 +
 +
All AIX servers must have a device entry in an organizer below the <span class="ph filepath">/Devices/Server/SSH/AIX</span> device class.
 +
 +
 +
<span class="notetitle">Note:</span>
 +
The SSH monitoring feature will attempt to use key-based authentication before using a configuration properties password value.
 +
 +
 +
<ol>
 +
<li>Navigate to the device class or device.
 +
 +
<ul>
 +
<li>If applying changes to a device class:
 +
 +
<ol>
 +
<li>Select the class in the devices hierarchy.
 +
</li>
 +
<li>Click '''Details'''.
 +
</li>
 +
<li>Select Configuration Properties.
 +
</li></ol>
 +
</li>
 +
<li>If applying changes to a device:
 +
 +
<ol>
 +
<li>Click the device in the device list.
 +
</li>
 +
<li>Select Configuration Properties.
 +
</li></ol>
 +
</li></ul>
 +
</li>
 +
<li>Verify the credentials for the service account to access the service.
 +
 +
 +
{| class="wikitable"
 +
|+ <span class="tablecap"><span class="tablecap">AIX Configuration Properties</span></span>
 +
!width="50%"|Name
 +
!width="50%"|Description
 +
|-
 +
|zCommandUsername
 +
 +
|AIX user with privileges to gather performance information
 +
 +
|-
 +
|zCommandPassword
 +
 +
|Password for the AIX user
 +
 +
|}
 +
 +
 +
</li>
 +
<li>Click <span class="ph uicontrol guibutton">Save</span> to save your changes.
 +
</li></ol>
 +
 +
 +
== Resolving CHANNEL_OPEN_FAILURE Issues ==
 +
 +
 +
The <span class="keyword cmdname">zencommand</span> daemon's log file (<span class="ph filepath">$ZENHOME/<var class="keyword varname replaceable">collector</var>/zencommand.log</span>) may show messages stating:
 +
 +
<pre class="pre codeblock screen">ERROR zen.SshClient CHANNEL_OPEN_FAILURE: Authentication failure
 +
WARNING:zen.SshClient:Open of command failed (error code 1): open failed</pre>
 +
If the <span class="keyword cmdname">sshd</span> daemon's log file on the remote device is examined, it may report that the <samp class="ph codeph literal">MAX_SESSIONS</samp> number of connections has been exceeded and that it is denying the connection request. At least in the OpenSSH daemons, this <samp class="ph codeph literal">MAX_SESSIONS</samp> number is a compile-time option and cannot be reset in a configuration file.
 +
 +
To work around this limitation of the <span class="keyword cmdname">sshd</span> daemon, use the configuration property <var class="keyword varname">zSshConcurrentSessions</var> to control the number of connections created by <span class="keyword cmdname">zencommand</span> to the remote device.
 +
 +
 +
<ol>
 +
<li>Navigate to the device or device class in the <span class="ph">Zenoss platform</span> interface.
 +
 +
<ul>
 +
<li>If applying changes to a device class:
 +
 +
<ol>
 +
<li>Select the class in the devices hierarchy.
 +
</li>
 +
<li>Click '''Details'''.
 +
</li>
 +
<li>Select Configuration Properties.
 +
</li></ol>
 +
</li>
 +
<li>If applying changes to a device:
 +
 +
<ol>
 +
<li>Click the device in the device list.
 +
</li>
 +
<li>Select Configuration Properties.
 +
</li></ol>
 +
</li></ul>
 +
</li>
 +
<li>Apply an appropriate value for the maximum number of sessions.
 +
 +
 +
{| class="wikitable"
 +
|+ <span class="tablecap"><span class="tablecap">Concurrent SSH Configuration Properties</span></span>
 +
!width="50%"|Name
 +
!width="50%"|Description
 +
|-
 +
|zSshConcurrentSessions
 +
 +
|Maximum number of sessions supported by the remote device's <samp class="ph codeph literal">MAX_SESSIONS</samp> parameter. Common values for AIX are 2 or 10.
 +
 +
|}
 +
 +
 +
</li>
 +
<li>Click '''Save''' to save your changes.
 +
</li></ol>
 +
 +
 +
== Resolving Timeout Issues ==
 +
 +
 +
The <span class="keyword cmdname">zencommand</span> daemon's log file (<span class="ph filepath">$ZENHOME/<var class="keyword varname replaceable">collector</var>/zencommand.log</span>) may show messages stating:
 +
 +
<pre class="pre codeblock screen">WARNING:zen.zencommand:Command timed out on device device_name: command</pre>
 +
If this occurs, it usually indicates that the remote device has taken too long to return results from the commands. To increase the amount of time for devices to return results, change the configuration property <var class="keyword varname">zCommandCommandTimeout</var> to a larger value.
 +
 +
 +
<ol>
 +
<li>Navigate to the device or device class in the <span class="ph">Zenoss platform</span> interface.
 +
 +
<ul>
 +
<li>If applying changes to a device class:
 +
 +
<ol>
 +
<li>Select the class in the devices hierarchy.
 +
</li>
 +
<li>Click '''Details'''.
 +
</li>
 +
<li>Select Configuration Properties.
 +
</li></ol>
 +
</li>
 +
<li>If applying changes to a device:
 +
 +
<ol>
 +
<li>Click the device in the device list.
 +
</li>
 +
<li>Select Configuration Properties.
 +
</li></ol>
 +
</li></ul>
 +
</li>
 +
<li>Apply an appropriate value for the command timeout.
 +
 +
 +
{| class="wikitable"
 +
|+ <span class="tablecap"><span class="tablecap">SSH Timeout Configuration Properties</span></span>
 +
!width="50%"|Name
 +
!width="50%"|Description
 +
|-
 +
|zCommandCommandTimeout
 +
 +
|The number of seconds to wait for commands to complete on the remote device.
 +
 +
|}
 +
 +
 +
</li>
 +
<li>Click '''Save''' to save your changes.
 +
</li></ol>
 +
 +
 +
== Daemons ==
 +
 +
 +
{| class="wikitable"
 +
!width="50%"|Type
 +
!width="50%"|Name
 +
|-
 +
|Modeler
 +
|<span class="keyword cmdname">zenmodeler</span>
 +
|-
 +
|Performance Collector
 +
|<span class="keyword cmdname">zencommand</span>
 +
|}
 
{{ZenPackFooter}}
 
{{ZenPackFooter}}

Revision as of 21:10, 24 February 2014


Note: This ZenPack is available in commercial versions of Zenoss. Click here to request more information about this commercial ZenPack. Click here to see all commercial ZenPacks.

Organization
Zenoss, Inc.
ZenPack name
ZenPacks.zenoss.AixMonitor


Applications Monitored: 



AIX ZenPack

The AIX Monitor ZenPack enables Resource Manager to use Secure Shell (SSH) to monitor AIX hosts.

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 included with commercial versions of Zenoss and enterprise support for this ZenPack is provided to Zenoss customers with an active subscription.

Releases

Background

The ZenPacks.zenoss.AixMonitor ZenPack uses Secure Shell (SSH) to monitor AIX hosts.


This ZenPack models and monitors devices placed in the /Server/SSH/AIX device class by running commands and parsing the output. The account used to monitor the device does not require root access or special privileges.

This ZenPack provides:

  • File system and process monitoring
  • Network interfaces and route modeling
  • CPU utilization information
  • Hardware information (memory, number of CPUs, machine serial numbers, model numbers)
  • OS information (OS level command style information)
  • LPP and RPM information (such as installed software)


Prerequisites

Prerequisite Restriction
Product Zenoss platform 4.x
Required ZenPacks ZenPacks.zenoss.AixMonitor
AIX Releases Supported 5.3 and 6.1


Note: If using a distributed collector setup, SSH requires firewall access (default of port 22) from the collector to the monitored server.


Add an AIX Server

The following procedure assumes that the credentials have been set.


  1. From Infrastructure > Devices, select Add a Single Device.
  2. Enter the following information in the dialog:
    Adding AIX Device Information
    Name Description
    Name or IP AIX host to model
    Device Class /Server/SSH/AIX
    Model Device Select this option unless adding a device with username/password different than found in the device class. If you do not select this option, then you must add the credentials, and then manually model the device.


  3. Click Add Device to add the device.


Set AIX Server Monitoring Credentials

All AIX servers must have a device entry in an organizer below the /Devices/Server/SSH/AIX device class.


Note: The SSH monitoring feature will attempt to use key-based authentication before using a configuration properties password value.


  1. Navigate to the device class or device.
    • If applying changes to a device class:
      1. Select the class in the devices hierarchy.
      2. Click Details.
      3. Select Configuration Properties.
    • If applying changes to a device:
      1. Click the device in the device list.
      2. Select Configuration Properties.
  2. Verify the credentials for the service account to access the service.
    AIX Configuration Properties
    Name Description
    zCommandUsername AIX user with privileges to gather performance information
    zCommandPassword Password for the AIX user


  3. Click Save to save your changes.


Resolving CHANNEL_OPEN_FAILURE Issues

The zencommand daemon's log file ($ZENHOME/collector/zencommand.log) may show messages stating:

ERROR zen.SshClient CHANNEL_OPEN_FAILURE: Authentication failure
WARNING:zen.SshClient:Open of command failed (error code 1): open failed

If the sshd daemon's log file on the remote device is examined, it may report that the MAX_SESSIONS number of connections has been exceeded and that it is denying the connection request. At least in the OpenSSH daemons, this MAX_SESSIONS number is a compile-time option and cannot be reset in a configuration file.

To work around this limitation of the sshd daemon, use the configuration property zSshConcurrentSessions to control the number of connections created by zencommand to the remote device.


  1. Navigate to the device or device class in the Zenoss platform interface.
    • If applying changes to a device class:
      1. Select the class in the devices hierarchy.
      2. Click Details.
      3. Select Configuration Properties.
    • If applying changes to a device:
      1. Click the device in the device list.
      2. Select Configuration Properties.
  2. Apply an appropriate value for the maximum number of sessions.
    Concurrent SSH Configuration Properties
    Name Description
    zSshConcurrentSessions Maximum number of sessions supported by the remote device's MAX_SESSIONS parameter. Common values for AIX are 2 or 10.


  3. Click Save to save your changes.


Resolving Timeout Issues

The zencommand daemon's log file ($ZENHOME/collector/zencommand.log) may show messages stating:

WARNING:zen.zencommand:Command timed out on device device_name: command

If this occurs, it usually indicates that the remote device has taken too long to return results from the commands. To increase the amount of time for devices to return results, change the configuration property zCommandCommandTimeout to a larger value.


  1. Navigate to the device or device class in the Zenoss platform interface.
    • If applying changes to a device class:
      1. Select the class in the devices hierarchy.
      2. Click Details.
      3. Select Configuration Properties.
    • If applying changes to a device:
      1. Click the device in the device list.
      2. Select Configuration Properties.
  2. Apply an appropriate value for the command timeout.
    SSH Timeout Configuration Properties
    Name Description
    zCommandCommandTimeout The number of seconds to wait for commands to complete on the remote device.


  3. Click Save to save your changes.


Daemons

Type Name
Modeler zenmodeler
Performance Collector zencommand

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.zenoss.AixMonitor-*.egg
  4. Restart these services:
    $ zenoss restart


Discuss

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

blog comments powered by Disqus