forked from xkilian/genDevConfig
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathINSTALL
executable file
·187 lines (131 loc) · 6.51 KB
/
INSTALL
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
##############################################################################
#
# INSTALL: genDevConfig
#
##############################################################################
genDevConfig - Generate a Shinken host and service config for a network device.
For the given device, generate a Shinken configuration directory. Within this
directory it will place a "deviname" file which will contain the following
logical information:
define host {
host_name ...
...
}
define service {
chassis_target
}
...
custom_target1
...
custom_targetN
interface_target1
...
interface_targetN
##############################################################################
#
# Elements of genDevConfig
#
##############################################################################
- util/genDevConfig # The script
- util/CHANGES # Functional changes
- util/CREDITS # Thank you notes to contributors
- util/INSTALL # How to install this script in Cricket
- etc/ # Expected location of genDevConfig-conf.pl
- sample-config/genConfig/Defaults # Shinken Defaults (NOT USED YET)
- sample-config/genConfig/Defaults.* # Shinken device specific Defaults (NOT USED YET)
- sample-config/genConfig/Defaults_unified.ini # Shinken unified Defaults file
- sample-config/genConfig/Defaults_triggers.ini # Shinken triggers(NOT USED YET)
- sample-config/genConfig/snmp-template.cfg # Shinken template
- lib/genConfig/File.pm # Utility library for genDevConfig
- lib/genConfig/SNMP.pm # Utility library for genDevConfig
- lib/genConfig/Utils.pm # Utility library for genDevConfig
- lib/genConfig/plugin.pm # Utility library for genDevConfig
- lib/genConfig/pluginUtils.pm # Utility library for genDevConfig
- lib/genConfig/log.pm # Utility library for genDevConfig imported from Cricket 1.05
- lib/genConfig/snmpUtils.pm # Utility library for genDevConfig imported from Cricket 1.05
- lib/monitorConfig # The configuration file for
# Cricket monitor thresholds (NOT USED)
- plugins/genConfig/ # The plugin directory containing plugins
- plugins/genConfig/CiscoIOS.pm # A plugin
- plugins/genConfig/CatalystCatOS.pm # Another plugin
- plugins/genConfig/...
##############################################################################
#
# Installation
#
##############################################################################
### Prerequisites
1 - Insure you have the right version of Perl. You should be using Perl 5.004 or higher. You can check by running "perl -V".
2 - Install the following Perl modules for genDevConfig to work correctly
Module From
--------------------------------------------------------------------
SNMP_Session http://code.google.com/p/snmp-session/downloads/detail?name=SNMP_Session-1.13.tar.gz&can=2&q=
Date::Parse CPAN: by-authors/id/GBARR/TimeDate-*.tar.gz
MD5 CPAN: by-authors/id/GAAS/Digest-MD5-*.tar.gz
### Step 0
If you want to integrate the script directly in your CRICKET installation. STOP.
download genDevConfig version 2.x instead of release 3.x [This series] which is meant
for use with Shinken.
### Step 1
Copy genDevConfig file structure to your $genDevConfig/ directory.
Make sure the genDevConfig script is executable by your user. And that all
files are owned by the user.
### Step 2 (Copying the Defaults_unified.ini file to shinken/etc/SnmpBooster)
If you use the genDevConfig Defaults file included in this release within
your Shinken confige (see the example below). You should replace the
Defaults files with the new versions.
Note: If you do *NOT* use a vanilla version of the genDevConfig Defaults
file, then you must copy the changes from the new Defaults file to your
own custom Defaults.
Example of creating and copying the Defaults files to the Shinken SNMP folder:
# For lazy bash users
export genDevConfig=/path/to/genDevConfig
export SHINKEN=/path/to/shinken
cd $SHINKEN/etc
mkdir SNMP
cp $genDevConfig/sample-config/genDevConfig/Defaults_unified.ini $SHINKEN/etc/SNMP/
cp $genDevConfig/sample-config/genDevConfig/snmp-template.cfg $SHINKEN/etc/
### Step 3 Configure SnmpBooster
Follow instructions on enabling SnmpBooster:
http://www.shinken-monitoring.org/wiki/setup_snmp_booster_module
##############################################################################
#
# Using genDevConfig - Basic
#
##############################################################################
### Step 1
Find out the community string and IP adress of the device you want to reach
### Step 2
Add the hostname to your /etc/hosts file or into DNS
### Step 3
Do a test call of the device before anything else
cd $genDevConfig/util
./genDevConfig -C community-name --verbose HOSTNAME
You can consult www.acktomic.com/cricket/genRtrConfig.html for more information on how to call genDevConfig from the command-line.
### Step 4
Verify the creation of the configuration for chassis, interfaces..
vi HOSTNAME/targets
##############################################################################
#
# Using genDevConfig - Advanced
#
# For even more information lookup the genDevConfig pages at:
# http://www.acktomic.com
#
##############################################################################
If multiple interfaces with identical interface descriptions are
found, these interfaces will have their inst numbers hard coded with
the ifIndex.
Interfaces that are administratively down, in test mode, have a speed
of 0, or have certain interface types (null, vlan, LAPD, DS0, DS1, software
loopback) will be commented out in the config.
Temperature Graphs: For those routers that support temperature readings, the
graphs default to degrees Celsius. This can be changed in the INI file.
Gotchas:
Some Bay routers return interface type 'Other' for 100BaseT interfaces,
causing those interfaces to be commented out in the target file. Try -e.
Some Cisco routers return incorrect interface types for some interfaces.
Example: Tunnel interfaces return type 0 under IOS 12.0.7T on a 7206
rather than the expected type 131. Try "-e 'Tunnel.*'".
Graphs statements in the Defaults* INI files are not used, but are there for future conversion to Graphite Templates.
Shinken SnmpBooster module cannot read the Defaults file yet, use the Defaults_unified.ini configuration file.