-
Notifications
You must be signed in to change notification settings - Fork 0
/
INSTALL
201 lines (143 loc) · 6.56 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
187
188
189
190
191
192
193
194
195
196
197
198
199
##############################################################################
#
# INSTALL: genDevConfig
#
##############################################################################
genDevConfig - Generate Cricket config tree for a network device.
For the given device, generate a Cricket config tree directory. Within this
directory it will place a "targets" file which will contain the following
logical information:
device-name
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
- sample-config/genConfig/Defaults # The cricket config-tree Defaults
- sample-config/genConfig/Defaults.* # The cricket config-tree module Defaults
- 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/monitorConfig # The configuration file for
# Cricket monitor thresholds
- plugins/genConfig/ # The plugin directory containing plugins
- plugins/genConfig/CiscoIOS.pm # A plugin
- plugins/genConfig/CatalystCatOS.pm # Another plugin
- plugins/genConfig/...
##############################################################################
#
# Installation
#
##############################################################################
### Step 1
Copy genDevConfig to your $CRICKET/util directory.
Make sure the genDevConfig script is executable by your user. And that all
files are owned by your cricket user.
### Step 2
Copy the utils to your $CRICKET/lib directory
Copy the plugins to your $CRICKET/plugins/genDevConfig/ directory
### Step 3 (Optional)
If this is the first time you install genDevConfig 2.0.x and higher
Copy monitorConfig to your $CRICKET/lib directory
If this is not your first time, take a peek at the monitorConfig file to see
if anything new was added.
### Step 4 (Copying the Defaults file to your cricket-config tree)
If you use the genDevConfig Defaults file included in this release within
your Cricket config-tree (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 Default files:
# For lazy bash users
$ export CRICKET=/path/to/cricket-base
$ cd $CRICKET/cricket-config
$ mkdir telecom-tree
$ cp $CRICKET/sample-config/genDevConfig/Defaults* \
$CRICKET/cricket-config/telecom-tree/
##############################################################################
#
# 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
./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 Cricket genRtrConfig pages at:
# http://www.acktomic.com
#
##############################################################################
If multiple interfaces with identical interface descriptions are
found, these interfaces will have their inst numbers hard coded and
the ifIndex.
A warning will appear at the bottom of the HTML pages generated by the
grapher unless the --nodupwarn flag is given. (requires mods to the
default HTML page-footer entry)
Interfaces that are administratively down, in test mode, have a speed
of 0, or have certain interface types (null, 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
./cricket-config/telecom-tree/Defaults file as follows:
graph tempInlet
color = dark-green
draw-as = AREA
y-axis = "degrees Celsius"
units = "°C"
# y-axis = "degrees Farenheit"
# units = "°F"
# scale = 9,*,5,/,32,+
space = ""
legend = "Inlet temperature"
precision = integer
graph tempOutlet
color = blue
y-axis = "degrees Celsius"
units = "°C"
# y-axis = "degrees Farenheit"
# units = "°F"
# scale = 9,*,5,/,32,+
space = ""
legend = "Outlet temperature"
precision = integer
To display degrees Farenheit, comment out the y-axis and units lines in both
graph definitions, uncomment the three lines following, (y-axis, units,
and scale) and recompile the comfig tree. This does not affect data storage,
only the way it's displayed.
This is one possible way to handle routers with Cricket.
There may or may not be better ones for any given environment.
Suggestions and improvements welcome.
Gotchas:
If you're using Cricket 1.02 or earlier, you'll need to uncomment the
SNMP v2 section in the Defaults file (sample-config/cisco-routers/Defaults)
and make sure you have SNMP_Session 0.77 or later.
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.*'".