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
|
=head1 NAME
Net::CLI::Interact::Manual::Cookbook - Miscellaneous recipes
=head1 Windows Support
The library works just fine under native windows (i.e use something like
Strawberry Perl - no need for cygwin), for Telnet, Serial and SSH connections.
However one additional step is required for you to have success:
You B<must> download the C<plink.exe> application, and pass its filesystem
location in the C<app> parameter to C<new()>. Do not try to use any other
Telnet or SSH programs (for instance the Windows bundled C<telnet>) - they
I<will not work>. Here's an example:
my $s = Net::CLI::Interact->new(
personality => "cisco",
transport => "Telnet",
(Net::CLI::Interact::Transport::is_win32() ?
(app => "$ENV{HOMEPATH}\\Desktop\\plink.exe") : () ),
);
=head1 Unix Support
The library works fine on most Unix platforms. It will try to use the native
C<telnet>, C<ssh> (openssh) and C<cu> programs for Telnet, SSH and Serial
connections, respectively. If you want to use another application, pass it in
the C<app> parameter to C<new>.
In some Unix environments there can be zombie child processes left around
after running your script. If this happens, set the C<reap> option, like so:
my $s = Net::CLI::Interact->new(
personality => "cisco",
transport => "Telnet",
connect_options => {
reap => 1,
},
);
=head1 Phrasebook Entries
=head2 Prompts
These are nothing more than named regular expressions:
prompt configure
match /\(config[^)]*\)# ?$/
=head2 Macros
This example waits for the device to ask "[startup-config]?" and then responds
with the text C<startup-config>.
macro copy_run_start
send copy running-config startup-config
match /Destination filename \[startup-config\]\?$/
send startup-config
To send instead a press of the Return key (I<output record separator>), use:
macro write_mem
send copy running-config startup-config
match /Destination filename \[startup-config\]\?$/
send ''
To instead allow the user to pass in the file name, use a C<sprintf> format.
macro save_to_file
send copy running-config startup-config
match /Destination filename \[startup-config\]\?$/
send %s
The user I<must> then pass a parameter to the C<macro> call, even if it's an
empty string:
$s->macro('save_to_file', { params => ['file_name'] });
# or
$s->macro('save_to_file', { params => [''] });
=head2 Continuations
These are Macros which start with a match instead of a send:
macro more_pages
match / --More-- /
send ' '
Note that the parameter of the C<send> is I<not> sent with a Return character
(I<output record separator>) appended.
When included in a macro, the continuation can be in-line, like this:
macro show_ip_route
send show ip route
follow / --More-- / with ' '
=head1 Running Commands
=head2 Standalone Commands
Simply send the command you wish to execute to the library. If not already
done, a connection to the device will be established automatically:
$s->cmd('show ip int br');
Normally this matches against a default prompt, which has been discovered
automatically, or set by you:
$s->set_prompt('user_prompt');
It's also possible to pass in a custom prompt for this command only:
$s->cmd('show ip int br', { match => qr/special prompt>$/ });
=head2 Composite Macro Commands
Call a predefined Macro from the phrasebook using this method:
$s->macro('write_mem');
Sometimes the Macro needs parameters:
$s->macro('to_priv_exec', { params => ['my_password'] });
You can't really create a Macro on the fly very easily, but with suitable use
of C<cmd()>, C<set_prompt()>, and the C<match> option to C<cmd()> it's
possible to achieve some simple flexibility.
=head1 Reconfiguring On-the-Fly
=head2 Phrasebook
It's possible to load a new phrasebook by the following method, which must be
passed at least the name of the personality:
$s->set_phrasebook({ personality => 'ios' });
You can pass any options which the
L<Phrasebook|Net::CLI::Interact::Phrasebook> module itself would take.
=head2 Prompt
The current prompt can be changed by passing the name of the new Prompt as it
is known by the phrasebook:
$s->set_prompt('name');
If you want to test whether the current prompt matches a diffrent named Prompt
from the phrasebook, this method can be used:
$s->prompt_looks_like('name');
=cut
|
