summaryrefslogtreecommitdiffstats
path: root/share/cisco-load.exp
blob: 0c2854977b00908459b547d11228bcfbc8393dca (plain)
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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
##
## $Id: cisco-load.exp,v 1.10 2004/01/11 03:43:50 heas Exp $
##
##
## Copyright (C) 1997-2004 by Terrapin Communications, Inc.
## All rights reserved.
##
## This software may be freely copied, modified and redistributed
## without fee for non-commerical purposes provided that this license
## remains intact and unmodified with any RANCID distribution.
##
## There is no warranty or other guarantee of fitness of this software.
## It is provided solely "as is".  The author(s) disclaim(s) all
## responsibility and liability with respect to this software's usage
## or its effect upon hardware, computer systems, other software, or
## anything else.
##
## Except where noted otherwise, rancid was written by and is maintained by
## Henry Kilmer, John Heasley, Andrew Partan, Pete Whiting, and Austin Schutz.
##
#
# this expect snipit is sourced by clogin (-s option) to load a configuration
# file (named <routername>-confg into nvram from an rcp/tftp host.  this is an
# _example_ as it not guaranteed to work for all applications.  PLEASE test
# for your environment.
#
# it expects the following variables via the -E option:
#	rcphost		='host to rcp from' such as 'foo.org' or '192.168.0.1'
#	confgpath	='path under /tftpboot where configs are held'
#
# the config file is expected to be routername-confg, where routername is the
# name as grok'd from the router's cmd-line prompt
#
# example usage:
# % clogin -s ./cisco-load.exp -Ercphost=foo.shrubbery.net router
# router
# loading router config from foo.shrubbery.net
#
# keep in mind that it is important to NOT polute the global variable space.
# particularly, do not use variables used within clogin.  this may result in
# indeterministic results.  an easy way to avoid this is to use a variable
# name prefix (like 'E' or '_').
#
# useful variables from clogin global space:
#	router		router name as provided on the cmd-line
#	prompt		cmd-line prompt as determined by clogin
#
# note: the tcl/expect parser is extremely stoopid.  comment lines are NOT
#       completely ignored!!  so, a '{' or '}' in a comment might produce
#       unexpected results.
##
# log_user 1
# exp_internal 1

# sometimes this is a bit slow.  note: this overrides clogin -t
set timeout 90

# take rcp host from -Ercphost='foo'
if ([info exists Ercphost]) {
	#puts "CONFGHOST == $Ercphost"
	set confghost [string tolower $Ercphost]
} else {
	send_error "ERROR: -Ercphost= was not set on the command-line.\n"
	exit
}

#
# logout of the router
#
proc logout { ecode } {
    global prompt

    send "quit\r"
    expect {
	"$prompt"       { logout $ecode }
	timeout { send_error "Error: timeout waiting for EOF after quit\n"}
	eof     {
		send_user "\n"
		exit $ecode }
    }
}

#
# erase the nvram
#
proc erase { } {
    global prompt

    send "\r"
    expect $prompt {}
    send "write erase\r"
    expect {
	-re " Continue\[^\n\]\*confirm\]" {
		send	"\r"
		exp_continue }
	"$prompt"       { }
	timeout {
		send_error "Error: timeout waiting for write erase.\n"
		logout 1 }
	eof     { logout 1 }
    }
}

#
# load a config via rcp into nvram
#
proc doload { confghost routername config retry } {
    global prompt

    # send a return just to be sure we have a prompt.
    send "\r"
    expect	"$prompt"
    # start the copy and send the host to load from
    # use tftp if retry == 1
    if { $retry == 0 } {
	send "copy tftp startup-config\r"
    } else {
	send "copy rcp startup-config\r"
    }
    expect {
		timeout	{
			send_error	"\nError: timeout exceeded waiting for rcp/tftp host prompt\r"
			logout 1 }
		"mbiguous command" {
			if { $retry == 0 } {
			    send "copy tftp: startup-config\r"
			} else {
			    send "copy rcp: startup-config\r"
			}
			exp_continue }
		-re "Host or network .*\]\?" {
			send	"host\r"
			exp_continue }
		"\]\?" {
			send	"$confghost\r" }
    }

    #
    # fill in the rest of the blanks.  username (12.0), filename, dest, etc.
    #
    expect	{
	-re "Source username .\*\]\?" {
		send	"$routername\r";
		exp_continue }
	-re "Source filename .\*\]\?" {
		send	"$config\r";
		exp_continue }
	-re "Name of configur.\*\]\?" {
		send	"$config\r";
		exp_continue }
	-re "Destination filename .\*\]\?" {
		send	"startup-config\r";
		exp_continue }
	-re "Configure using .\*confirm\]"	{ send	"\r" }
	"proceed\? \\\["			{ send	"yes\r" }
	-re "Do you want to over write.\*confirm\]"	{ send	"\r" }
	-re "Accessing (rcp|tftp):"		{ }
	timeout {
		send_error "\n\tError: timeout exceeded while matching load prompts\n";
		send "" }
    }

    expect {
	timeout {
		send_error "Error: timeout exceeded while loading config\n"
		logout 1 }
	-re "\[^\n\]*Connection refused" {
		send_error "Error: $expect_out(0,string)\n" 
		logout 1 }
	-re "\[^\n\]*Destination unreachable" {
		send_error "Error: $expect_out(0,string)\n" 
		logout 1 }
	-re "\[^\n\]*Permission denied" {
		send_error "Error: $expect_out(0,string)\n"
		logout 1 }
	-re "\[^\n]*No such file or directory" {
		send_error "Error: $expect_out(0,string)\n"
		logout 1 }
	-re "\[^\n]*Error copying\[^\n]*Not enough space on device\[^\n]*\r" {
		send_error "Error: $expect_out(0,string)\n"
		if { $retry == 2 } {
# erase stomps ssh rsa key
#    			send_user "erasing nvram\n"
#			erase
    			send_user "retrying load\n"
			doload $confghost $routername $config 1
		} elseif { $retry == 1 } {
# erase stomps ssh rsa key
#    			send_user "erasing nvram\n"
#			erase
    			send_user "retrying load with tftp.\n"
			doload $confghost $routername $config 0
		} else {
			send_error "Error: $expect_out(0,string)\n"
			logout 1
		} }
	-re "\[^\n]*.*configuration is too large.*\n" {
		send_error "Error: $expect_out(0,string)\n"
		expect {
			-re "\[^\n]*Truncate config.*:" { send "no\r" }
			}
		logout 1 }
	-re "\[^\n]*Error (opening|copying).*\r" {
		send_error "Error: $expect_out(0,string)\n"
		logout 1 }
        -nocase -re "\[^\n]* error\[^a-z\n]+\[^\n]*" {
                send_error "$expect_out(0,string)\n"
                logout 1 }
	"\n"		{ exp_continue }
	-re "^\[^ ]*\#"	{
		send_user "load successful.\n"
		}
    }

    return 0;
}

send_user "loading $router config from $confghost\n";

# look for router hostname in prompt (i.e.: deal with fqdn)
send "\r"
expect {
    timeout 	{
	send_error "Error: did not receive prompt\n"
	exit }
    "\n"	{ exp_continue }
    -re "^(\[^ ]*)\#" {
	set routername $expect_out(1,string) }
}

# deal with config subdir?  from Econfgpath
if ([info exists confgpath]) {
	set config	"$confgpath/$routername-confg"
} else {
	set config	"$routername-confg"
}

# load the config
if { [doload $confghost $routername $config 1] != 0 } {
    logout 1
}

logout 0

# these were my original transcripts of performing loads.  it is a useful
# example of info you may collect to get an idea of what needs to be handled
# in the expect{}s
#  
#  pdx-oob#
#  pdx-oob#copy rcp start
#  Address of remote host [255.255.255.255]? 205.238.52.35
#  Name of configuration file [a]? pdx-oob-confg
#  Configure using pdx-oob-confg from 205.238.52.35? [confirm]
#  
#  Connected to 205.238.52.35
#  Loading 8131 byte file pdx-oob-confg: !!!! [OK]
#  Compressing configuration from 8131 bytes to 3886 bytes
#  [OK]
#  pdx-oob#
#  

#  12.0S-isms
#  pao2#cop rcp sta
#  Address or name of remote host []? eng0
#  Translating "eng0"...domain server (205.238.52.46) [OK]
#  
#  Source username [pao2]? 
#  Source filename []? pao2-confg
#  Destination filename [startup-config]? 
#  Warning: Copying this config directly into the nvram from a network server may
#           cause damage the the startup config. It is advisable to copy the file
#           into the running config first, and then save it using copy run start.
#  Do you wish to proceed? [no]: yes
#  Accessing rcp://pao2@eng0/pao2-confg...
#  Connected to 205.238.52.35
#  Loading 30138 byte file pao2-confg: !!!!!! [OK]
#  
#  30138 bytes copied in 2.576 secs (15069 bytes/sec)
#  pao2#
# OR IS IT
#  sea0#cop rcp sta
#  Address or name of remote host []? eng0
#  Source username [sea0]? 
#  Source filename []? sea0-confg
#  Destination filename [startup-config]? 
#  Accessing rcp://sea0@eng0/sea0-confg...!!!!!!!!!!!!!!!!!!
#  89794 bytes copied in 0.704 secs
#  sea0#q
#  Connection closed by foreign host.

#  pdx-oob#copy rcp start
#  Address of remote host [255.255.255.255]? 205.238.52.35
#  Name of configuration file [a]? pdx-oob-confg
#  Configure using pdx-oob-confg from 205.238.52.35? [confirm]
#  
#  Connected to 205.238.52.35
#  Loading 8131 byte file pdx-oob-confg: !!!! [OK]
#  Compressing configuration from 8131 bytes to 3886 bytes
#  [OK]
#  pdx-oob#copy rcp start
#  Address of remote host [205.238.52.35]? 205.238.52.35
#  Name of configuration file [pdx-oob-confg]? pdx-oob-confg
#  Configure using pdx-oob-confg from 205.238.52.35? [confirm]
#  
#  Connected to 205.238.52.35
#  %rcp: /tftpboot/pdx-oob-confg: No such file or directory
#  pdx-oob#
#  

#  pdx-oob#copy rcp start
#  Address of remote host [205.238.52.35]? 205.238.52.35 
#  Name of configuration file [pdx-oob-confg]? pdx-oob-confg 
#  Configure using pdx-oob-confg from 205.238.52.35? [confirm]
#  
#  Connected to 205.238.52.35
#  %rcp: /tftpboot/pdx-oob-confg: Permission denied
#  pdx-oob#
#

#  *** response from filtered pkt
#  pdx-oob#copy rcp sta
#  Address of remote host [205.238.52.35]? 205.238.1.94
#  Name of configuration file [pdx-oob-confg]? 
#  Configure using pdx-oob-confg from 205.238.1.94? [confirm]
#  % Destination unreachable; gateway or host down
#  
#  pdx-oob#
#  

#  *** response from host w/o rcp daemon
#  pdx-oob#cop rcp sta 
#  Address of remote host [205.238.52.35]? 205.238.1.66
#  Name of configuration file [pdx-oob-confg]? 
#  Configure using pdx-oob-confg from 205.238.1.66? [confirm]
#  % Connection refused by remote host
#  
#  pdx-oob#
#