SSH Cacti Plugin 1.0 Released

[N3NCY]

SSH Cacti Plugin 1.0 Released

Go easy on me, this is my first try at creating a plugin!


In short:
This plugin adds a tab into Cacti that has an embedded Java SSH client.
The client is built using the JTA:
http://javassh.org

Install (Like most other typical plugins):
Download / ungzip / untar and copy to your plugins folder.
Example from UNIX:
(You will need to edit this to point to where you have Cacti installed of course)
cd /usr/src
wget http://forums.cacti.net/download.php?id=11871
mv "download.php?id=11871" ssh.tar.gz
tar xvf ssh.tar.gz -C /opt/apache/htdocs/cacti/plugins/
# Add the plug-in to the array
vi /opt/apache/htdocs/cacti/include/global.php
$plugins = array();
$plugins[] = 'ssh';
# Reset file permissions (make sure you use the correct user:group for your server of course)
chown -R www:www /opt/apache/htdocs

Log in to your Cacti web interface and verify that the plug-in is working.
Note: Many plug-ins require you to allow permission for each web user to view and use the new plug-in.
From the Cacti web interface, Click the "Console" tab then click "User Management" and pick the user of your choice and verify the check boxes.
Make sure View SSH is checked.

Next tell the plugin the name or IP of your SSH server:
Click the Console tab then Settings then the Misc tab and fill in SSH Host

Notes:
- You need to have Java installed on your workstation (for use with your browser / this embedded plugin)
- You need to have a functional SSH server running on your Cacti box (or somewhere) for this plugin to connect to

Environment:
Built on my development FreeBSD VMware machine and tested under these conditions with IE7 on Windows XP with Sun Java 1.5x:

Cacti Version - 0.8.7a
Plugin Architecture - 1.4
Poller Type - CMD.php
Server Info - FreeBSD 6.2-RELEASE
Web Server - Apache/2.2.6 (Unix) mod_ssl/2.2.6 OpenSSL/0.9.8g DAV/2 PHP/5.2.5 mod_perl/2.0.3 Perl/v5.8.8
PHP - 5.2.5
PHP Extensions - xmlwriter, libxml, dom, xmlreader, xml, tokenizer, session, pcre, SimpleXML, SPL, PDO, sockets, soap, snmp, SQLite, standard, Reflection, posix, pdo_sqlite, pdo_dblib, odbc, mysql, mssql, mbstring, ldap, json, iconv, hash, gd, ftp, filter, exif, dbase, dba, date, curl, ctype, calendar, bz2, bcmath, zlib, openssl, apache2handler
MySQL - 5.0.51
RRDTool - 1.2.26
SNMP - 5.4.1
Plugins

• Global Plugin Settings (settings - v0.3)
  Host Info (hostinfo - v0.2)
  Network Discovery (discovery - v0.8.3)
  Device Tracking (mactrack - v1.1)
  Read-only Devices Tab (devices - v0.4)
  SuperLinks (superlinks - v0.72)
  Update Checker (update - v0.4)
  Network Tools (tools - v0.2)
  Device Monitoring (monitor - v0.8.2)
  Thresholds (thold - v0.3.9)
  PHP Network Managing (manage - v0.5.1)
  Syslog Monitoring (syslog - v0.5.2)
  NTop Viewer (ntop - v0.1)
  B.A.S.E Viewer (B.A.S.E - v0.1)
  Cycle Graphs (Cycle Graphs - v0.4)
  ReportIt (ReportIt - v0.5.1)
  Documents (docs - v0.1)
  SSH Viewer (ssh - v1.0)
  IP subnet Calculator IPv4 IPv6 (ipsubnet - v.4d)
  Poller Performance Report (pollperf - v0.32)
  Real-time statistics (zond - v0.34a)
  Create Aggregate Graphs (aggregate - v0.64)
  RRD File Cleaner (RRD Cleaner - v0.32)
  Configuration manager (configmanager - v0.75)

Thank you to the entire Cacti team for continued work on Cacti including Jimmy Conner for great plugin examples!

[streaker69]

Where's the Small Tab? Huh? Geez.. I expect small tabs.

[N3NCY]

It is in the images directory.

[streaker69]

Call me if you're still up.

[Howie]

Where's the Small Tab? Huh? Geez.. I expect small tabs.

Those small tabs ought to have a different name to the big ones you know... then you don't have to mangle your Cacti install to switch between the two sizes.

(neat plugin n3ncy )

[streaker69]

Where's the Small Tab? Huh? Geez.. I expect small tabs.

Those small tabs ought to have a different name to the big ones you know... then you don't have to mangle your Cacti install to switch between the two sizes.

(neat plugin n3ncy )

I agree, but we'd need someone that knows more than I do to actually write a plugin that allows switching between big and small.

Plus we'd need a standard naming convention for big/small and up/down as well as agree upon a format.

Oh, and I was only harrassing him so much because he's a good friend of mine, in case you were wondering. I wouldn't do that to just anyone that's putting out a plugin.

[eternal]

[Tue Jan 22 10:25:53 2008] [error] [client foo] File does not exist: /var/www/html/plugins/ssh/de


I get error
And can never login.



Any easy way to add more than one host?

[apperrault]

looking at this plugin, is it safe to assume that this is for Unix type installs only?

looks like a great plugin, and i would love to use it on Windows.

app

[TheWitness]

Yummy Can I make some changes?

TheWitness

[N3NCY]

TheWitness: Make any changes you like!

Howie: The small tabs do have a different name.
Do you have a standard naming convention I should be using?
BTW, I used your Superlinks to create the tabs in my screen cap above!
We need to integrate tab creation into the plugin architecture based on your Superlinks code so people making plugins don't need to make tabs.
In fact, I think your Superlinks could make a nice start towards a "theme" capability for Cacti. Thank you for Superlinks!

apperrault: The plugin itself will run from a Windows Cacti.
You will need to point to a valid SSH server on the config tab.

eternal: Do you have Java installed on your workstation?
And yes, this plugin could be modified for more hosts.
I picture a future version that works like the Zond plugin and puts a button next to each graph that allows you to SSH or Telnet to every host you want.

streaker69: You call me!

And I think I can implement auto switching between small and large tabs, but getting Howie's input would be better.

-Ernie

[apperrault]

Wow, that looks pretty cool. One question though. All of our devices connect via SSH2 on port 22, not over port 23, how would i make that change?

Also, is there a way to make the SSH connect dynamic? Rather than only have the ability to connect to one machine, make is something where i can type in the IP address or DNS name and connect that way? Or even better, if there was a way to tie it to the hosts table (like manage or monitor where you can put a check mark for SSH) so i could specify a specific host with the ability to SSH to it.

OMG the possibilities are endless.

Thanks for the plugin.

app

[N3NCY]

apperrault: The current default now is SSH on TCP port 22

[apperrault]

That is what i thought. When i start the plugin i get the following message:

Code: Select all

sorry, could not connect to XX.XX.XX.XX 23

Let me know if you have any thoughts. i looked at the .conf file and it is indeed set to use port 22, so i dont understand why it is trying port 23.

Thanks again

app

[N3NCY]

apperrault: It sounds like the config file is not being read.
Does the web server have permission to read the config?

[gilles]

i use this too in manage 0.5.2
but i open it in a new browser
i support also mrelay[d] for connecting to others hosts and URI scheme to allow a user to specify his own programs (putty, telnet...)