Net-Appliance-Session-4.200002/000755 000765 000024 00000000000 12717073412 016451 5ustar00oliverstaff000000 000000 Net-Appliance-Session-4.200002/bin/000755 000765 000024 00000000000 12717073411 017220 5ustar00oliverstaff000000 000000 Net-Appliance-Session-4.200002/Changes000644 000765 000024 00000025605 12717072440 017754 0ustar00oliverstaff000000 000000 4.200002 2015-05-18 * Change shebang line in nas script 4.200001 2015-05-14 * Remove dangerous use lib from nas script (ppisar) 4.200000 2015-01-06 * Migrate away from Dist::Zilla 4.142720 2014-09-29 19:44:29 Europe/London * Docs update for Cisco NX-OS which has max terminal of 511 4.140230 2014-01-23 20:48:04 Europe/London * [RT#92376] timeout when incorrect privileged password 4.131260 2013-05-06 20:36:23 Europe/London * Minor fix for incorrect data type on timeout 4.131210 2013-05-01 21:45:36 Europe/London * Expose global timeout setting * Add nci_options setting for passing not-natively-supported options to NCI 4.122741 2012-09-30 15:05:51 Europe/London * Bug fix for info messages in nas script 4.122740 2012-09-30 14:35:47 Europe/London * RANCID .cloginrc support for nas script 4.122730 2012-09-29 23:56:37 Europe/London * Add scripting system bin/nas * Export Try::Tiny methods as better alternative to eval() * Update for the prompts named "prompt" which are now called "generic" * Improve documentation on use of custom phrasebook libraries 4.122630 2012-09-19 17:23:45 Europe/London * Port from Moose to Moo * Remove APIv2 back-compat module 3.122530 2012-09-09 15:54:04 Europe/London * should be checking for "user" prompt not macro! * alter default suggested log level to 'notice' 3.122100 2012-07-29 00:44:52 Europe/London * Support serial console servers where the console might be asleep (C. Tucker) 3.122010 2012-07-19 20:50:58 Europe/London * Try enable_paging and disable_paging macros before generic 'paging' (C. Tucker) * Add links to transport man pages in documentation. 3.121640 2012-06-12 23:24:42 Europe/London * Library version number is logged at instatiation. 3.121570 2012-06-05 19:56:02 Europe/London * Change async interface put() to be say() because of the auto-newline * If connection fails, the transport (ssh, telnet, etc) error is emitted * Do not run disconnect macro when connect fails (J. Whitten) 3.120580_001 2012-02-27 21:47:51 Europe/London * Implement async interface - put() and gather() (rt.cpan #75201) 3.120560 2012-02-25 17:20:36 Europe/London * fix POD typo and add NAME to APIv2 (C. Vicente) * fix Win32 path for plink.exe 3.113610 2011-12-27 00:54:02 Europe/London * New implementation of output parser. Note the following: For the cmd() and macro() methods: In scalar context all data is returned. In list context the gathered response is returned as a list of lines. In both cases your local platform's newline character will end all lines. 3.113600 2011-12-26 16:36:25 Europe/London * Issue disconnect macro if the phrasebook has one, on close() * Fix bug in privileged_password implementation (reported by Paul Niemi) 3.112610 2011-09-18 10:42:28 Europe/London * Add more tests for found bugs * Add note to POD about terminal width (Mathias) 3.112600 2011-09-17 14:24:53 Europe/London * Add test for pipe in command (V. Foitzik) 3.112510 2011-09-08 22:06:06 Europe/London * Added privileged_password option (J. Roth rt.cpan#69139) 3.112290 2011-08-17 20:16:43 Europe/London * Added native last_prompt (on request of G.Peirce) 3.112190 2011-08-07 22:20:13 Europe/London * Make add_library work (for scalar only) 3.111690 2011-06-18 08:24:15 Europe/London * Fix incorrect username accessor method name (cvicente rt.cpan #68897) * Loosen type constraint on connect_options (cvicente rt.cpan #68899) 3.111600 2011-06-09 11:08:43 Europe/London * Add delegation methods for Net::Telnet to APIv2 * Tidy and fix a couple of things in the example script 3.111590 2011-06-08 23:28:03 Europe/London * Implement v2 API compat layer 3.111530 2011-06-02 23:45:26 Europe/London * Ported to Net::CLI::Interact backend 2.111080 2011-04-18 10:13:04 Europe/London * Spot login auth failures, Steve C. (rt.cpan #67487) 2.110470 2011-02-16 19:23:54 Europe/London * Prevent close() unless already opened, Steve C. (rt.cpan #65453) 2.110090 2011-01-09 11:14:48 Europe/London * Fix bug in use of close_called, Steve C. (rt.cpan #64450) 2.103641 2010-12-30 21:28:09 Europe/London * Observe output_record_separator, thanks Steve C. (rt.cpan #55187) * Protect against death spiral in timeout/close, also Steve C. (rt.cpan #53796) * Implement privileged_pagin method to manage ASA/PIX 7+ - Paul Graydon (rt.cpan #63359) 2.103640 2010-12-30 20:54:56 Europe/London * Port to Dist::Zilla libnet-appliance-session-perl (1.36) UNRELEASED; urgency=low * Add import of WNOHANG symbol from POSIX (reported by Dominik Gehl) -- Oliver Gorwits Fri, 23 Jan 2009 08:32:13 +0000 libnet-appliance-session-perl (1.35) UNRELEASED; urgency=low * Fix again for imported POSIX symbols on CENTOS 5 (reported by Dominik Gehl) -- Oliver Gorwits Wed, 31 Dec 2008 12:10:22 +0000 libnet-appliance-session-perl (1.34) UNRELEASED; urgency=low * Fix pod to mention new supported devices (JUNOS, HP, Nortel) -- Oliver Gorwits Tue, 30 Dec 2008 22:45:48 +0000 libnet-appliance-session-perl (1.33) UNRELEASED; urgency=low * Mention enable_paging and disable_paging methods (RT#40783) * Do not import symbols from POSIX (reported by Dominik Gehl) -- Oliver Gorwits Tue, 30 Dec 2008 22:08:13 +0000 libnet-appliance-session-perl (1.32) UNRELEASED; urgency=low * Fix bug in Telnet with no username (RT.cpan #40229) thanks to mstefanov -- Oliver Gorwits Sat, 8 Nov 2008 21:12:38 +0000 libnet-appliance-session-perl (1.31) UNRELEASED; urgency=low * Move to using Module::Install * Update License to be same terms as Perl -- Oliver Gorwits Sat, 8 Nov 2008 17:08:58 +0000 libnet-appliance-session-perl (1.26) UNRELEASED; urgency=low * Make all method params case insensitive (requested by raimundh) (this follows what Net::Telnet does) -- Oliver Gorwits Tue, 2 Sep 2008 13:16:34 +0100 libnet-appliance-session-perl (1.25) UNRELEASED; urgency=low * Fix the buggy SIGCHLD handler (reported by Andrew D. Clark) -- Oliver Gorwits Sun, 17 Aug 2008 18:33:23 +0100 libnet-appliance-session-perl (1.24) UNRELEASED; urgency=low * Add use of FileHandle in the Transport - seems to be a 5.10 issue? -- Oliver Gorwits Fri, 18 Jul 2008 14:08:27 +0100 libnet-appliance-session-perl (1.23) UNRELEASED; urgency=low * Added support for debugging shell on failure, see Devel::REPL::Plugin::NAS -- Oliver Gorwits Tue, 3 Jun 2008 17:41:01 +0100 libnet-appliance-session-perl (0.22) UNRELEASED; urgency=low * Add disconnect method to Transport, as a noop except for Serial (see RT.cpan#35937) -- Oliver Gorwits Sat, 17 May 2008 20:28:32 +0100 libnet-appliance-session-perl (0.21) unstable; urgency=low * Send SIGKILL to child if we're running in cygwin * Minor fix to typo in Cookbook -- Oliver Gorwits Sat, 2 Feb 2008 19:12:28 +0000 libnet-appliance-session-perl (0.19) unstable; urgency=low * Bug fix for not setting last prompt (thx miky) * Minor change to docs to mention setting in_foo_mode -- Oliver Gorwits Sat, 19 Jan 2008 21:51:29 +0000 libnet-appliance-session-perl (0.18) unstable; urgency=low * Now automatically reap child processes -- Oliver Gorwits Sun, 23 Dec 2007 14:35:03 +0000 libnet-appliance-session-perl (0.17) unstable; urgency=low * Minor fixes to Cookbook POD to improve CPAN rendering. -- Oliver Gorwits Tue, 4 Dec 2007 21:08:00 +0000 libnet-appliance-session-perl (0.16) unstable; urgency=low * Add Cookbook courtesy of Nigel Bowden. -- Oliver Gorwits Tue, 4 Dec 2007 19:06:00 +0000 libnet-appliance-session-perl (0.15) unstable; urgency=low * Users report that the child reaping isn't stable across all systems, so revert to old system of doing nothing -- Oliver Gorwits Tue, 3 Jul 2007 16:40:00 +0100 libnet-appliance-session-perl (0.14) unstable; urgency=low * Allow SSH Transport to handle username prompts, suggestion courtesy of Nigel Bowden * Set Unix systems to automatically reap child processes -- Oliver Gorwits Tue, 3 Jul 2007 13:23:00 +0100 libnet-appliance-session-perl (0.13) unstable; urgency=low * Bug in my use of Class::Data::Inheritable. A schoolboy-error :( -- Oliver Gorwits Mon, 29 Jan 2007 16:48:00 +0000 libnet-appliance-session-perl (0.12) unstable; urgency=low * Bug in SSH Transport which would catch someone out one day -- Oliver Gorwits Sun, 28 Jan 2007 23:46:00 +0000 libnet-appliance-session-perl (0.11) unstable; urgency=low * Add CheckPB option to allow (almost) complete disabling of phrasebook entry checks * Separate out phrasebook entry checking in case not all required (e.g. not going to use configure mode) * Add special named argument to cmd() allowing operation more like Net::Telnet's waitfor() * Add Opts option to SSH Engine to support arbitrary openssh args -- Oliver Gorwits Sun, 28 Jan 2007 20:54:00 +0000 libnet-appliance-session-perl (0.09) unstable; urgency=low * Remove all hard-coded command phrases and prompt regexps, they are now pulled from the loaded phrasebook so can be overridden * Check all phrases are actually in the loaded phrasebook at instantiation time and die if any are not available * As a result, now require Net::Appliance::Phrasebook >= 0.07 * Allow user to disable login (user/pass) negotiation e.g. for public route servers * Also allow user to disable paging management, or override the number of lines used to re-enable paging * Also allow user to disable privileged and configure modes (see docs) * New Transport for Serial Line access, called 'Serial' (not tested much) * New Transport for Telnet access, called 'Telnet' (not tested much) * Factor out the IO::Pty code into Transport base class. Also checked it out, and it's actually pretty sane, so can stay in. -- Oliver Gorwits Tue, 14 Nov 2006 11:59:00 +0000 libnet-appliance-session-perl (0.05) unstable; urgency=low * Major rewrite - move Phrasebook out into Net::Appliance::Phrasebook - remove all the require guff and have it properly inheriting namespaces - rewrite Exception class into a module -- Oliver Gorwits Tue, 19 Sep 2006 18:16:17 +0100 libnet-appliance-session-perl (0.01) unstable; urgency=low * Initial Release. -- Oliver Gorwits Tue, 11 Jul 2006 18:16:17 +0100 Net-Appliance-Session-4.200002/examples/000755 000765 000024 00000000000 12717073411 020266 5ustar00oliverstaff000000 000000 Net-Appliance-Session-4.200002/lib/000755 000765 000024 00000000000 12717073411 017216 5ustar00oliverstaff000000 000000 Net-Appliance-Session-4.200002/Makefile.PL000644 000765 000024 00000002716 12717073337 020437 0ustar00oliverstaff000000 000000 use strict; use warnings; use ExtUtils::MakeMaker 6.30; my %WriteMakefileArgs = ( "ABSTRACT" => "Run command-line sessions to network appliances", "AUTHOR" => "Oliver Gorwits ", "BUILD_REQUIRES" => { "Test::More" => "0.88" }, "CONFIGURE_REQUIRES" => { "ExtUtils::MakeMaker" => "6.30" }, "DISTNAME" => "Net-Appliance-Session", "EXE_FILES" => [ "bin/nas" ], "LICENSE" => "perl", "NAME" => "Net::Appliance::Session", "PREREQ_PM" => { "Cwd" => 0, "Data::Dumper" => 0, "Getopt::Long" => "2.24", "IO::Handle" => 0, "IO::Prompt::Tiny" => 0, "Moo" => 0, "Moo::Role" => 0, "MooX::Types::MooseLike::Base" => 0, "Net::CLI::Interact" => "2.200005", "Sub::Quote" => 0, "Term::ANSIColor" => 0, "Term::ReadPassword" => 0, "Text::Glob" => 0, "Text::ParseWords" => 0, "Try::Tiny" => 0, "strict" => 0, "warnings" => 0 }, "VERSION" => "4.200002", "test" => { "TESTS" => "t/*.t" } ); unless ( eval { ExtUtils::MakeMaker->VERSION(6.56) } ) { my $br = delete $WriteMakefileArgs{BUILD_REQUIRES}; my $pp = $WriteMakefileArgs{PREREQ_PM}; for my $mod ( keys %$br ) { if ( exists $pp->{$mod} ) { $pp->{$mod} = $br->{$mod} if $br->{$mod} > $pp->{$mod}; } else { $pp->{$mod} = $br->{$mod}; } } } delete $WriteMakefileArgs{CONFIGURE_REQUIRES} unless eval { ExtUtils::MakeMaker->VERSION(6.52) }; WriteMakefile(%WriteMakefileArgs); Net-Appliance-Session-4.200002/MANIFEST000644 000765 000024 00000001200 12717073412 017573 0ustar00oliverstaff000000 000000 bin/nas Changes examples/example-1.pl lib/Net/Appliance/Session.pm lib/Net/Appliance/Session/Async.pm lib/Net/Appliance/Session/Engine.pm lib/Net/Appliance/Session/Scripting.pm lib/Net/Appliance/Session/Transport.pm Makefile.PL MANIFEST This list of files META.yml t/10-use.t t/author-10_route_server.t t/author-12_route_server_nonblock.t t/author-20_local_device.t t/author-22_local_privileged_pass.t t/author-30_local_device_ssh.t t/author-31_local_device_ssh_extra.t t/author-32_sdf_shell.t t/author-41_ssh_unknown_host.t t/author-42_ssh_fail_close.t META.json Module JSON meta-data (added by MakeMaker) Net-Appliance-Session-4.200002/META.json000644 000765 000024 00000002757 12717073412 020105 0ustar00oliverstaff000000 000000 { "abstract" : "Run command-line sessions to network appliances", "author" : [ "Oliver Gorwits " ], "dynamic_config" : 1, "generated_by" : "ExtUtils::MakeMaker version 7.16, CPAN::Meta::Converter version 2.150005", "license" : [ "perl_5" ], "meta-spec" : { "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", "version" : "2" }, "name" : "Net-Appliance-Session", "no_index" : { "directory" : [ "t", "inc" ] }, "prereqs" : { "build" : { "requires" : { "Test::More" : "0.88" } }, "configure" : { "requires" : { "ExtUtils::MakeMaker" : "6.30" } }, "runtime" : { "requires" : { "Cwd" : "0", "Data::Dumper" : "0", "Getopt::Long" : "2.24", "IO::Handle" : "0", "IO::Prompt::Tiny" : "0", "Moo" : "0", "Moo::Role" : "0", "MooX::Types::MooseLike::Base" : "0", "Net::CLI::Interact" : "2.200005", "Sub::Quote" : "0", "Term::ANSIColor" : "0", "Term::ReadPassword" : "0", "Text::Glob" : "0", "Text::ParseWords" : "0", "Try::Tiny" : "0", "strict" : "0", "warnings" : "0" } } }, "release_status" : "stable", "version" : "4.200002", "x_serialization_backend" : "JSON::PP version 2.27203" } Net-Appliance-Session-4.200002/META.yml000644 000765 000024 00000001624 12717073411 017724 0ustar00oliverstaff000000 000000 --- abstract: 'Run command-line sessions to network appliances' author: - 'Oliver Gorwits ' build_requires: Test::More: '0.88' configure_requires: ExtUtils::MakeMaker: '6.30' dynamic_config: 1 generated_by: 'ExtUtils::MakeMaker version 7.16, CPAN::Meta::Converter version 2.150005' license: perl meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.4.html version: '1.4' name: Net-Appliance-Session no_index: directory: - t - inc requires: Cwd: '0' Data::Dumper: '0' Getopt::Long: '2.24' IO::Handle: '0' IO::Prompt::Tiny: '0' Moo: '0' Moo::Role: '0' MooX::Types::MooseLike::Base: '0' Net::CLI::Interact: '2.200005' Sub::Quote: '0' Term::ANSIColor: '0' Term::ReadPassword: '0' Text::Glob: '0' Text::ParseWords: '0' Try::Tiny: '0' strict: '0' warnings: '0' version: '4.200002' x_serialization_backend: 'CPAN::Meta::YAML version 0.012' Net-Appliance-Session-4.200002/t/000755 000765 000024 00000000000 12717073411 016713 5ustar00oliverstaff000000 000000 Net-Appliance-Session-4.200002/t/10-use.t000644 000765 000024 00000001267 12715670416 020126 0ustar00oliverstaff000000 000000 #!/usr/bin/perl -w use strict; use Test::More 0.88; BEGIN { use_ok('Net::Appliance::Session') } my $s = new_ok('Net::Appliance::Session' => [{ transport => 'Serial', personality => 'cisco', }], 'new instance' ); foreach (qw( logged_in in_privileged_mode in_configure_mode do_paging do_login do_privileged_mode do_configure_mode get_username get_password set_username set_password pager_disable_lines pager_enable_lines connect close enable_paging disable_paging begin_privileged end_privileged begin_configure end_configure )) { ok( $s->can($_), "can do method $_"); } done_testing; Net-Appliance-Session-4.200002/t/author-10_route_server.t000644 000765 000024 00000001616 12715670416 023436 0ustar00oliverstaff000000 000000 #!/usr/bin/perl BEGIN { unless ($ENV{AUTHOR_TESTING}) { require Test::More; Test::More::plan(skip_all => 'these tests are for testing by the author'); } } use strict; use warnings FATAL => 'all'; use Test::More 0.88; BEGIN { use_ok( 'Net::Appliance::Session') } my $s = new_ok( 'Net::Appliance::Session' => [{ transport => "Telnet", ($^O eq 'MSWin32' ? (app => "$ENV{HOMEPATH}\\Desktop\\plink.exe") : () ), host => "route-server.bb.pipex.net", personality => "cisco", do_login => 0, do_paging => 0, timeout => 5, nci_options => { timeout => 5 }, }]); ok( $s->connect ); ok( $s->cmd('show ip bgp 163.1.0.0/16'), 'ran show ip bgp 163.1.0.0/16' ); like( $s->last_prompt, qr/\w+ ?>$/, 'command ran and last_prompt looks ok' ); my @out = $s->last_response; cmp_ok( scalar @out, '==', 15, 'sensible number of lines in the command output'); done_testing; Net-Appliance-Session-4.200002/t/author-12_route_server_nonblock.t000644 000765 000024 00000001600 12715670416 025316 0ustar00oliverstaff000000 000000 #!/usr/bin/perl BEGIN { unless ($ENV{AUTHOR_TESTING}) { require Test::More; Test::More::plan(skip_all => 'these tests are for testing by the author'); } } use strict; use warnings FATAL => 'all'; use Test::More 0.88; BEGIN { use_ok( 'Net::Appliance::Session') } my $s = new_ok( 'Net::Appliance::Session' => [{ transport => "Telnet", ($^O eq 'MSWin32' ? (app => "$ENV{HOMEPATH}\\Desktop\\plink.exe") : () ), host => "route-server.bb.pipex.net", personality => "cisco", do_login => 0, do_paging => 0, }]); ok( $s->connect ); ok( $s->say("show ip bgp 163.1.0.0/16"), 'sent show ip bgp 163.1.0.0/16' );; ok( $s->gather(), 'gathered output' ); like( $s->last_prompt, qr/\w+ ?>$/, 'command ran and last_prompt looks ok' ); my @out = $s->last_response; cmp_ok( scalar @out, '==', 16, 'sensible number of lines in the command output'); done_testing; Net-Appliance-Session-4.200002/t/author-20_local_device.t000644 000765 000024 00000003002 12715670416 023313 0ustar00oliverstaff000000 000000 #!/usr/bin/perl BEGIN { unless ($ENV{AUTHOR_TESTING}) { require Test::More; Test::More::plan(skip_all => 'these tests are for testing by the author'); } } BEGIN { if ($ENV{NOT_AT_HOME}) { require Test::More; Test::More::plan(skip_all => 'these tests can only be run by the author when at home'); } } use strict; use warnings FATAL => 'all'; use Test::More 0.88; BEGIN { use_ok( 'Net::Appliance::Session') } my $s = new_ok( 'Net::Appliance::Session' => [{ transport => "Telnet", ($^O eq 'MSWin32' ? (app => "$ENV{HOMEPATH}\\Desktop\\plink.exe") : () ), host => '172.16.20.55', personality => "ios", }]); my @out = (); ok( $s->connect({ username => 'Cisco', password => ($ENV{IOS_PASS} || 'letmein') }), 'connected' ); ok( $s->cmd('show clock'), 'ran show clock' ); cmp_ok( (scalar $s->last_response), '=', 1, 'one line of clock'); ok( $s->cmd('show version'), 'ran show ver, no paging' ); @out = $s->last_response; cmp_ok( scalar @out, '>', 20, 'lots of ver lines'); ok( $s->begin_privileged, 'begin priv, no pass' ); ok( eval{$s->end_privileged;1}, 'end priv' ); ok( $s->begin_privileged({password => ($ENV{IOS_PASS} || 'letmein')}), 'begin priv, with pass' ); ok( $s->cmd('show ip int br'), 'ran show ip int br' ); @out = $s->last_response; cmp_ok( scalar @out, '=', 6, 'six interface lines'); ok( $s->begin_configure, 'begin configure' ); ok( eval{$s->end_configure;1}, 'end configure' ); ok( eval{$s->close;1}, 'disconnected, backed out of privileged' ); done_testing; Net-Appliance-Session-4.200002/t/author-22_local_privileged_pass.t000644 000765 000024 00000002516 12715670416 025247 0ustar00oliverstaff000000 000000 #!/usr/bin/perl BEGIN { unless ($ENV{AUTHOR_TESTING}) { require Test::More; Test::More::plan(skip_all => 'these tests are for testing by the author'); } } BEGIN { if ($ENV{NOT_AT_HOME}) { require Test::More; Test::More::plan(skip_all => 'these tests can only be run by the author when at home'); } } use strict; use warnings FATAL => 'all'; use Test::More 0.88; BEGIN { use_ok( 'Net::Appliance::Session') } my $s = new_ok( 'Net::Appliance::Session' => [{ transport => "Telnet", ($^O eq 'MSWin32' ? (app => "$ENV{HOMEPATH}\\Desktop\\plink.exe") : () ), host => '172.16.20.55', personality => "ios", }]); my @out = (); ok( $s->connect({ username => 'Cisco', password => ($ENV{IOS_PASS} || 'letmein'), privileged_password => ($ENV{IOS_PASS} || 'letmein') . 'x', }), 'connect with bad privileged_password' ); # should fail eval { $s->begin_privileged }; like( $@, qr/read timed-out|timeout on timer/, 'begin priv, bad pass' ); ok( eval{$s->close;1}, 'disconnected' ); # should be OK ok( $s->connect({ username => 'Cisco', password => ($ENV{IOS_PASS} || 'letmein'), privileged_password => ($ENV{IOS_PASS} || 'letmein') . '', }), 'connected ok' ); ok( $s->begin_privileged, 'begin priv, no pass' ); ok( eval{$s->close;1}, 'disconnected, backed out of privileged' ); done_testing; Net-Appliance-Session-4.200002/t/author-30_local_device_ssh.t000644 000765 000024 00000003174 12715670416 024203 0ustar00oliverstaff000000 000000 #!/usr/bin/perl BEGIN { unless ($ENV{AUTHOR_TESTING}) { require Test::More; Test::More::plan(skip_all => 'these tests are for testing by the author'); } } BEGIN { if ($ENV{NOT_AT_HOME}) { require Test::More; Test::More::plan(skip_all => 'these tests can only be run by the author when at home'); } } use strict; use warnings FATAL => 'all'; use Test::More 0.88; BEGIN { use_ok( 'Net::Appliance::Session') } my $s = new_ok( 'Net::Appliance::Session' => [{ transport => "SSH", ($^O eq 'MSWin32' ? (app => "$ENV{HOMEPATH}\\Desktop\\plink.exe") : () ), host => '172.16.20.55', personality => "ios", connect_options => { shkc => 0, opts => [ '-o', 'CheckHostIP=no', ], }, }]); my @out = (); ok( $s->connect({ username => 'Cisco', password => ($ENV{IOS_PASS} || 'letmein'), }), 'connected' ); ok( $s->cmd('show clock'), 'ran show clock' ); cmp_ok( (scalar $s->last_response), '=', 1, 'one line of clock'); ok( $s->cmd('show version'), 'ran show ver, no paging' ); @out = $s->last_response; cmp_ok( scalar @out, '>', 20, 'lots of ver lines'); ok( $s->begin_privileged, 'begin priv, no pass' ); ok( eval{$s->end_privileged;1}, 'end priv' ); ok( $s->begin_privileged({password => ($ENV{IOS_PASS} || 'letmein')}), 'begin priv, with pass' ); ok( $s->cmd('show ip int br'), 'ran show ip int br' ); @out = $s->last_response; cmp_ok( scalar @out, '=', 6, 'six interface lines'); ok( $s->begin_configure, 'begin configure' ); ok( eval{$s->end_configure;1}, 'end configure' ); ok( eval{$s->close;1}, 'disconnected, backed out of privileged' ); done_testing; Net-Appliance-Session-4.200002/t/author-31_local_device_ssh_extra.t000644 000765 000024 00000003772 12715670416 025413 0ustar00oliverstaff000000 000000 #!/usr/bin/perl BEGIN { unless ($ENV{AUTHOR_TESTING}) { require Test::More; Test::More::plan(skip_all => 'these tests are for testing by the author'); } } BEGIN { if ($ENV{NOT_AT_HOME}) { require Test::More; Test::More::plan(skip_all => 'these tests can only be run by the author when at home'); } } use strict; use warnings FATAL => 'all'; use Test::More 0.88; #use Data::Dumper; BEGIN { use_ok( 'Net::Appliance::Session') } my $s = new_ok( 'Net::Appliance::Session' => [{ transport => "SSH", ($^O eq 'MSWin32' ? (app => "$ENV{HOMEPATH}\\Desktop\\plink.exe") : () ), host => '172.16.20.55', personality => "ios", connect_options => { shkc => 0, opts => [ '-o', 'CheckHostIP=no', ], }, }]); my @lines = (); ok( $s->connect({ username => 'Cisco', password => ($ENV{IOS_PASS} || 'letmein'), }), 'connected' ); # reported bug about using pipe command ok( $s->cmd('show ver | i PCA'), 'ran show ver - pipe for PCA' ); @lines = $s->last_response; #print STDERR Dumper \@lines; #print STDERR $s->last_response; cmp_ok( (scalar @lines), '==', 2, 'two lines of ver' ); unlike( scalar $s->cmd('show ver | i Processor'), qr/^\|/, 'no pipe at start of output' ); # bug about stitching together of output ok( $s->cmd('show ver'), 'ran show ver' ); @lines = $s->last_response; #print STDERR Dumper \@lines; #print STDERR $s->last_response; cmp_ok( (scalar @lines), '==', 47, '47 lines of ver' ); # reported bug about control characters affecting number of lines ok( $s->begin_privileged, 'move to privileged mode' ); ok( eval{$s->cmd('terminal width 512');1}, 'set terminal width' ); ok( $s->cmd('verify /md5 flash:c1140-k9w7-mx.124-25d.JA/c1140-k9w7-mx.124-25d.JA 5c45e360eb702702f29c5120ef4200fd'), 'ran verify md5' ); @lines = $s->last_response; #print STDERR Dumper \@lines; #print STDERR $s->last_response; cmp_ok( (scalar @lines), '==', 2, 'two lines of verify' ); #ok( eval{$s->close;1}, 'disconnected' ); eval{$s->close}; done_testing; Net-Appliance-Session-4.200002/t/author-32_sdf_shell.t000644 000765 000024 00000001635 12715670416 022662 0ustar00oliverstaff000000 000000 #!/usr/bin/perl BEGIN { unless ($ENV{AUTHOR_TESTING}) { require Test::More; Test::More::plan(skip_all => 'these tests are for testing by the author'); } } use strict; use warnings FATAL => 'all'; use Test::More 0.88; BEGIN { use_ok( 'Net::Appliance::Session') } my $s = new_ok( 'Net::Appliance::Session' => [{ transport => "SSH", ($^O eq 'MSWin32' ? (app => "$ENV{HOMEPATH}\\Desktop\\plink.exe") : () ), host => 'sdfeu.org', personality => "sdf", connect_options => { ignore_host_checks => 1, }, do_paging => 0, }]); ok( $s->connect({ username => 'ollyg', password => ($ENV{SDF_PASS} || 'letmein'), }), 'connected' ); ok( $s->cmd('ls -la'), 'ran ls -la' ); like( $s->last_prompt, qr{\$ $}, 'command ran and prompt looks ok' ); my @out = $s->last_response; cmp_ok( scalar @out, '==', 7, 'sensible number of lines in the command output'); done_testing; Net-Appliance-Session-4.200002/t/author-41_ssh_unknown_host.t000644 000765 000024 00000001147 12715670416 024326 0ustar00oliverstaff000000 000000 #!/usr/bin/perl BEGIN { unless ($ENV{AUTHOR_TESTING}) { require Test::More; Test::More::plan(skip_all => 'these tests are for testing by the author'); } } use strict; use warnings FATAL => 'all'; use Test::More 0.88; BEGIN { use_ok( 'Net::Appliance::Session') } my $s = new_ok( 'Net::Appliance::Session' => [{ transport => "SSH", ($^O eq 'MSWin32' ? (app => "$ENV{HOMEPATH}\\Desktop\\plink.exe") : () ), host => "bogus.example.com", personality => "cisco", }]); # should fail eval { $s->connect }; like( $@, qr/Could not resolve hostname/, 'Unknown Host' ); done_testing; Net-Appliance-Session-4.200002/t/author-42_ssh_fail_close.t000644 000765 000024 00000001260 12715670416 023667 0ustar00oliverstaff000000 000000 #!/usr/bin/perl BEGIN { unless ($ENV{AUTHOR_TESTING}) { require Test::More; Test::More::plan(skip_all => 'these tests are for testing by the author'); } } use strict; use warnings FATAL => 'all'; use Test::More 0.88; BEGIN { use_ok( 'Net::Appliance::Session') } my $s = new_ok( 'Net::Appliance::Session' => [{ transport => "SSH", ($^O eq 'MSWin32' ? (app => "$ENV{HOMEPATH}\\Desktop\\plink.exe") : () ), host => "bogus.example.com", personality => "cisco", }]); # should fail eval { $s->connect }; like( $@, qr/Could not resolve hostname/, 'Unknown Host' ); ok( eval{$s->close;1}, 'disconnected without pathological behaviour' ); done_testing; Net-Appliance-Session-4.200002/lib/Net/000755 000765 000024 00000000000 12717073411 017744 5ustar00oliverstaff000000 000000 Net-Appliance-Session-4.200002/lib/Net/Appliance/000755 000765 000024 00000000000 12717073411 021640 5ustar00oliverstaff000000 000000 Net-Appliance-Session-4.200002/lib/Net/Appliance/Session/000755 000765 000024 00000000000 12717073411 023263 5ustar00oliverstaff000000 000000 Net-Appliance-Session-4.200002/lib/Net/Appliance/Session.pm000644 000765 000024 00000040341 12717073360 023626 0ustar00oliverstaff000000 000000 package Net::Appliance::Session; { $Net::Appliance::Session::VERSION = '4.200002'; } use Moo; use Sub::Quote; use MooX::Types::MooseLike::Base qw(Bool Int Str HashRef InstanceOf); use Net::CLI::Interact; with 'Net::Appliance::Session::Transport'; with 'Net::Appliance::Session::Engine'; with 'Net::Appliance::Session::Async'; # import Try::Tiny try/catch/finally into caller's namespace sub import { my $caller = caller; eval <import(); ENDEVAL die $@ if $@; } foreach my $slot (qw/ logged_in in_privileged_mode in_configure_mode privileged_paging close_called /) { has $slot => ( is => 'rw', isa => Bool, required => 0, default => quote_sub('0'), ); } foreach my $slot (qw/ do_paging do_login do_privileged_mode do_configure_mode wake_up /) { has $slot => ( is => 'rw', isa => Bool, required => 0, default => quote_sub('1'), ); } foreach my $slot (qw/ username password privileged_password /) { has $slot => ( is => 'rw', isa => Str, required => 0, predicate => 1, reader => "get_$slot", writer => "set_$slot", ); } foreach my $slot (qw/ transport personality /) { has $slot => ( is => 'rw', isa => Str, required => 1, ); } foreach my $slot (qw/ host app add_library /) { has $slot => ( is => 'ro', isa => Str, required => 0, predicate => 1, ); } has 'timeout' => ( is => 'ro', isa => Int, required => 0, predicate => 1, ); has 'connect_options' => ( is => 'ro', isa => HashRef, required => 0, default => sub { {} }, ); has 'nci_options' => ( is => 'ro', isa => HashRef, required => 0, default => sub { {} }, ); has 'nci' => ( is => 'lazy', isa => InstanceOf['Net::CLI::Interact'], required => 1, predicate => 1, clearer => 1, handles => [qw/ cmd macro last_prompt last_response set_phrasebook set_global_log_at prompt_looks_like find_prompt /], ); sub _build_nci { my $self = shift; $self->connect_options->{host} = $self->host if $self->has_host; my $nci = Net::CLI::Interact->new({ transport => $self->transport, personality => $self->personality, connect_options => $self->connect_options, ($self->has_app ? (app => $self->app) : ()), ($self->has_add_library ? (add_library => $self->add_library) : ()), ($self->has_timeout ? (timeout => $self->timeout) : ()), %{ $self->nci_options }, }); $nci->logger->log('engine', 'notice', sprintf "NAS loaded, version %s", ($Net::Appliance::Session::VERSION || 'devel')); return $nci; } 1; # ABSTRACT: Run command-line sessions to network appliances __END__ =pod =head1 NAME Net::Appliance::Session - Run command-line sessions to network appliances =head1 VERSION version 4.200002 =head1 SYNOPSIS use Net::Appliance::Session; my $s = Net::Appliance::Session->new({ personality => 'ios', transport => 'SSH', host => 'hostname.example', privileged_paging => 1, # only if using ASA/PIX OS 7+ # and there are other behaviour options, see below }); try { $s->connect({ username => 'username', password => 'loginpass' }); $s->begin_privileged({ password => 'privilegedpass' }); print $s->cmd('show access-list'); $s->end_privileged; } catch { warn "failed to execute command: $_"; } finally { $s->close; }; or, try the bundled C helper script (beta feature!): nas --help =head1 DESCRIPTION Use this module to establish an interactive command-line session with a network appliance. There is special support for moving into "privileged" mode and "configure" mode, along with the ability to send commands to the connected device and retrieve returned output. There are other CPAN modules that cover similar ground, but they are less robust and do not handle native SSH, Telnet and Serial Line connections with a single interface on both Unix and Windows platforms. Built-in commands come from a phrasebook which supports many network device vendors (Cisco, HP, etc) or you can install a new phrasebook. Most phases of the connection are configurable for different device behaviours. =head1 METHODS As in the synopsis above, the first step is to create a new instance. Recommended practice is to wrap all other calls (except C) in a C block, to catch errors (typically time-outs waiting for CLI response). This module exports the C methods (from L) into your namespace as a simpler alternative to using C. For a full demonstration of usage, see the example script shipped with this distribution. =head2 Net::Appliance::Session->new( \%options ) my $s = Net::Appliance::Session->new({ personality => 'ios', transport => 'SSH', host => 'hostname.example', }); Prepares a new session for you, but will not connect to any device. Some options are required, others optional: =over 4 =item C<< personality => $name >> (required) Tells the module which "language" to use when talking to the connected device, for example C for Cisco IOS devices. There's a list of all the supported platforms in the L documentation. It's also possible to write new phrasebooks. =item C<< transport => $backend >> (required) The name of the transport backend used for the session, which may be one of L, L, or L. =item C<< app => $location >> (required on Windows) On Windows platforms, you B download the C program, and pass its location in this parameter. =item C<< host => $hostname >> (required for Telnet and SSH transports) When using the Telnet and SSH transports, you B provide the IP or host name of the target device in this parameter. =item C<< timeout => $seconds >> Configures a global default timeout value, in seconds, for interaction with the remote device. The default is 10 seconds. You can also set timeout on a per-command or per-macro call (see below). =item C<< connect_options => \%options >> Some of the transport backends can take their own options. For example with a serial line connection you might specify the port speed, etc. See the respective manual pages for each transport backend for further details (L, L, L). =item C<< add_library => $directory >> If you've added to the built-in phrasebook with your own macros, then use this option to load your new phrasebook file(s). The path here should be the directory within which all your personalities are located, such as: ${directory}/cisco/ios/pb ${directory}/other/device/pb Usually the phrasebook files are called "C" and to the C option you pass the containing directory name, for example C or C in the examples shown. See L for further details. =item C<< nci_options => \%options >> Should you wish to reconfigure the L instance used inside of C, perhaps for an option not supported above, this generic setting is available. =back =head2 connect( \%options ) $s->connect({ username => $myname, password => $mysecret }); To establish a connection to the device, and possibly also log in, call this method. Following a successful connection, paging of device output will be disabled using commands appropriate to the platform. This feature can be suppressed (see L, below). Options available to this method, sometimes required, are: =over 4 =item C<< username => $name >> The login username for the device. Whether this is required depends both on how the device is configured, and how you have configured this module to act. If it looks like the device presented a Username prompt. and you don't pass the username a Perl exception will be thrown. The username is cached within the module for possible use later on when entering "privileged" mode. =item C<< password => $secret >> The login password for the device. Whether this is required depends both on how the device is configured, and how you have configured this module to act. If it looks like the device presented a Username prompt. and you don't pass the username a Perl exception will be thrown. The password is cached within the module for possible use later on when entering "privileged" mode. =item C<< privileged_password => $secret >> (optional) In the situation where you've activated "privileged paging", yet your device uses a different password for privileged mode than login, you'll need to set that other password here. Otherwise, because the module tries to disable paging, it first goes into privileged mode as you instructed, and fails with the wrong (login) password. =back =head2 begin_privileged and end_privileged $s->begin_privileged; # do some work $s->end_privileged; Once you have connected to the device, change to "privileged" mode by calling the C method. The appropriate command will be issued for your device platform, from the phrasebook. Likewise to exit "privileged" mode call the C method. Sometimes authentication is required to enter "privileged" mode. In that case, the module defaults to using the username and password first passed in the C method. However to either override those or set them in case they were not passed to C, use either or both of the following options to C: $s->begin_privileged({ username => $myname, password => $mysecret }); =head2 begin_configure and end_configure $s->begin_configure; # make some changes $s->end_configure; To enter "configuration" mode for your device platform, call the C method. This checks you are already in "privileged" mode, as the module assumes this is necessary. If it isn't necessary then see L below to modify this behaviour. Likewise to exit "configure" mode, call the C method. =head2 cmd( $command ) my $config = $s->cmd('show running-config'); my @interfaces = $s->cmd('show interfaces brief'); Execute a single command statement on the connected device. The statement is executed verbatim on the device, with a newline appended. In scalar context the response is returned as a single string. In list context the gathered response is returned as a list of lines. In both cases your local platform's newline character will end all lines. You can also call the C method which returns the same data with the same contextual behaviour. This method accepts a hashref of options following the C<$command>, which can include a C value to permit long running commands to have all their output gathered. To handle more complicated interactions, for example commands which prompt for confirmation or optional parameters, you should use a Macro. These are set up in the phrasebook and issued via the C<< $s->macro($name) >> method call. See the L and L manual pages for further details. If you receive response text with a "mangled" copy of the issued command at the start, then it's likely you need to set the terminal width. This prevents the connected device from line-wrapping long commands. Issue something like: $s->begin_privileged; $s->cmd('terminal width 510'); =head2 close $s->close; Once you have finished work with the device, call this method. It attempts to back out of any "privileged" or "configuration" mode you've entered, re-enable paging (unless suppressed) and then disconnect. If a macro named C<"disconnect"> exists in the loaded phrasebook then it's called just before disconnection. This allows you to issue a command such as C<"exit"> to cleanly log out. =head1 CONFIGURATION Each of the entries below may either be passed as a parameter in the options to the C method, or called as a method in its own right and passed the appropriate setting. If doing the latter, it should be before you call the C method. =over =item do_login Defaults to true. Pass a zero (false) to disable logging in to the device with a username and password, should you get a command prompt immediately upon connection. =item do_privileged_mode Defaults to true. If on connecting to the device your user is immediately in "privieleged" mode, then set this to zero (false), which permits immediate access to "configure" mode. =item do_configure_mode Defaults to true. If you set this to zero (false), the module assumes you're in "configure" mode immediately upon entering "privileged" mode. I can't think why this would be useful but you never know. =item do_paging Defaults to true. Pass a zero (false) to disable the post-login reconfiguration of a device which avoids paged command output. If you cleanly C the device connection then paging is re-enabled. Use this option to suppress these steps. =item privileged_paging Defaults to false. On some series of devices, in particular the Cisco ASA and PIXOS7+ you must be in privileged mode in order to alter the pager. If that is the case for your device, call this method with a true value to instruct the module to better manage the situation. =item pager_enable_lines Defaults to 24. The command issued to re-enable paging (on disconnect) typically takes a parameter which is the number of lines per page. If you want a different value, set it in this option. =item pager_disable_lines Defaults to zero. The command issued to disable paging typically takes a parameter which is the number of lines per page (zero begin to disable paging). If your device uses a different number here, set it in this option. =item wake_up When first connecting to the device, the most common scenario is that a Username (or some other) prompt is shown. However if no output is forthcoming and nothing matches, the "enter" key is pressed, in the hope of triggering the display of a new prompt. This is typically most useful on Serial connected devices. Set this configuration option to zero to suppress this behaviour, or to the number of times "enter" should be pressed and output waited for. The default is to press "enter" once. =back =head1 ASYNCHRONOUS BEHAVIOUR The standard, and recommended way to use this module is as above, whereby the application is blocked waiting for command response. It's also possible to send a command, and separately return to ask for output at a later time. $s->say('show clock'); This will send the command C to the connected device, followed by a newline character. $s->gather(); This will gather and return output, with similar behaviour to C, above. That is, it blocks waiting for output and a prompt, will timeout, and accepts the same options. You can still use C after calling C, however be aware that the command (from C) may be echoed at the start of the output, depending on device and connection transport. =head1 DIAGNOSTICS To see a log of all the processes within this module, and a copy of all data sent to and received from the device, call the following method: $s->set_global_log_at('notice'); In place of C you can have other log levels (e.g. C for more, or C for less), and via the embedded L at C<< $s->nci->logger >> it's possible to finely control the diagnostics. =head1 INTERNALS See L. =head1 THANKS Over several years I have received many patches and suggestions for improvement from users of this module. My heartfelt thanks to all, for their contributions. =head1 AUTHOR Oliver Gorwits =head1 COPYRIGHT AND LICENSE This software is copyright (c) 2014 by Oliver Gorwits. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. =cut Net-Appliance-Session-4.200002/lib/Net/Appliance/Session/Async.pm000644 000765 000024 00000000730 12715670416 024704 0ustar00oliverstaff000000 000000 package Net::Appliance::Session::Async; { $Net::Appliance::Session::Async::VERSION = '4.142720'; } use Moo::Role; sub put { my ($self, $cmd, $opts) = @_; $opts ||= {}; return $self->nci->transport->put($cmd, ($opts->{no_ors} ? () : $self->nci->transport->ors)); } sub say { return $_[0]->put( $_[1] ) } sub gather { my ($self, $opts) = @_; $opts ||= {}; $opts->{no_ors} = 1; # force no newline return $self->cmd('', $opts); } 1; Net-Appliance-Session-4.200002/lib/Net/Appliance/Session/Engine.pm000644 000765 000024 00000012232 12715670416 025034 0ustar00oliverstaff000000 000000 package Net::Appliance::Session::Engine; { $Net::Appliance::Session::Engine::VERSION = '4.142720'; } use Moo::Role; use Sub::Quote; use MooX::Types::MooseLike::Base qw(Int); has 'pager_enable_lines' => ( is => 'rw', isa => Int, required => 0, default => quote_sub('24'), ); has 'pager_disable_lines' => ( is => 'rw', isa => Int, required => 0, default => quote_sub('0'), ); sub enable_paging { my $self = shift; return unless $self->do_paging; return unless $self->logged_in; my $privstate = $self->in_privileged_mode; $self->begin_privileged if $self->privileged_paging; my $pagercmd = ($self->nci->phrasebook->has_macro('enable_paging') ? 'enable_paging' : 'paging'); $self->macro($pagercmd, { params => [ $self->pager_enable_lines ]} ); $self->end_privileged if $self->privileged_paging and not $privstate; } sub disable_paging { my $self = shift; return unless $self->do_paging; return unless $self->logged_in; my $privstate = $self->in_privileged_mode; $self->begin_privileged if $self->privileged_paging; my $pagercmd = ($self->nci->phrasebook->has_macro('disable_paging') ? 'disable_paging' : 'paging'); $self->macro($pagercmd, { params => [ $self->pager_disable_lines ]} ); $self->end_privileged if $self->privileged_paging and not $privstate; } # method to enter privileged mode on the remote device. # optionally, use a different username and password to those # used at login time. if using a different username then we'll # explicily login rather than privileged. sub begin_privileged { my $self = shift; my $options = Net::Appliance::Session::Transport::ConnectOptions->new(@_); return unless $self->do_privileged_mode; return if $self->in_privileged_mode; die 'must connect before you can begin_privileged' unless $self->logged_in; # rt.cpan#47214 check if we are already enabled by peeking the prompt if ($self->prompt_looks_like('privileged')) { $self->in_privileged_mode(1); return; } # default is to re-use login credentials my $username = $options->has_username ? $options->username : $self->get_username; # rt.cpan#69139 support passing of privileged_password to the constructor my $password = $options->has_password ? $options->password : $self->has_privileged_password ? $self->get_privileged_password : $self->get_password; $self->macro('begin_privileged'); # whether login or enable, we still must be prepared for username if ($self->prompt_looks_like('user')) { die 'a set username is required to enter priv on this host' if not $username; $self->cmd($username, { match => 'pass' }); } if ($self->prompt_looks_like('pass')) { die 'a set password is required before begin_privileged' if not $password; # rt.cpan#92376 timeout when incorrect password $self->cmd($password, { match => 'generic' }); } $self->prompt_looks_like('privileged') or die 'should be in privileged mode but prompt does not match'; $self->in_privileged_mode(1); } sub end_privileged { my $self = shift; return unless $self->do_privileged_mode; return unless $self->in_privileged_mode; die 'must leave configure mode before leaving privileged mode' if $self->in_configure_mode; $self->macro('end_privileged'); not $self->prompt_looks_like('privileged') or die 'should have left privileged mode but prompt still matches'; $self->in_privileged_mode(0); } sub begin_configure { my $self = shift; return unless $self->do_configure_mode; return if $self->in_configure_mode; die 'must enter privileged mode before configure mode' unless $self->in_privileged_mode; # rt.cpan#47214 check if we are already in config by peeking the prompt if ($self->prompt_looks_like('configure')) { $self->in_configure_mode(1); return; } $self->macro('begin_configure'); $self->prompt_looks_like('configure') or die 'should be in configure mode but prompt does not match'; $self->in_configure_mode(1); } sub end_configure { my $self = shift; return unless $self->do_configure_mode; return unless $self->in_configure_mode; $self->macro('end_configure'); # we didn't manage to escape configure mode (must be nested?) if ($self->prompt_looks_like('configure')) { my $caller3 = (caller(3))[3]; # max out at three tries to exit configure mode if ( $caller3 and $caller3 =~ m/end_configure$/ ) { die 'failed to leave configure mode'; } # try again to exit configure mode else { $self->end_configure; } } # return if recursively called my $caller1 = (caller(1))[3]; if ( defined $caller1 and $caller1 =~ m/end_configure$/ ) { return; } not $self->prompt_looks_like('configure') or die 'should have exited configure mode but prompt still matches'; $self->in_configure_mode(0); } 1; Net-Appliance-Session-4.200002/lib/Net/Appliance/Session/Scripting.pm000644 000765 000024 00000026651 12715670416 025603 0ustar00oliverstaff000000 000000 package Net::Appliance::Session::Scripting; use strict; use warnings FATAL => 'all'; use Getopt::Long 2.24 qw(:config bundling); use Term::ANSIColor qw(colored); use Text::ParseWords qw(shellwords); use Term::ReadPassword qw(read_password); $Term::ReadPassword::USE_STARS = 1; use IO::Prompt::Tiny qw(prompt); use IO::Handle (); use Cwd qw(abs_path); use Data::Dumper (); use Try::Tiny; use Text::Glob qw(match_glob); use Net::Appliance::Session; our $VERSION = $Net::Appliance::Session::VERSION || '0.00031412'; my $banner = colored ['blue'], "Net Appliance Session scripting - v$VERSION - © 2012 by Oliver Gorwits\n"; my %options = (cloginrc_opts => {}); my $exit_status = 0; sub bailout { if (scalar @_) { print "\n", colored(['magenta bold'], @_) if scalar @_; } else { print $banner; } print < (default: "ios") -t, --transport method (Serial, Telnet, default: SSH) -u, --username to connect as on device (default: \$USER) -R, --record Record session -P, --playback Play back session -s, --script When recording, save playback script to this -l, --cmdlog NAS to record commands to, or play them back from -e, --exit-last Num. of output lines from last command is program exit status -c, --cloginrc RANCID cloginrc with device credentials -z, --nopassword Do not ask for device password (if not using cloginrc) -o, --echo Echo commands sent, when playing back the recorded script/cmdlog -M, --paging Do not attempt to disable command output paging -B, --nobanner Suppress display of any login banner received from the device -q, --quiet Hide informational messages -v, --verbose NCI log ("debug", "notice", "info", etc) -V, --version Display this program's version number -h, --help Display this help text Notes: * If hostname or IP is not specified, the script loops, waiting for hostnames to be entered passed on standard input, each one starting a new session. * When you disconnect from an interactive session there may be an input/output read error. You should run "!s close" to request a graceful disconnection. ENDUSAGE exit(0); } sub getopt { my @getoptconf = (qw/ personality|p=s transport|t=s username|u=s record|R playback|P script|s=s cmdlog|l=s exit-last|e cloginrc|c=s nopassword|z echo|o paging|M nobanner|B quiet|q verbose|v=s help|h version|V /); unshift @ARGV, shellwords($ENV{PERL_NAS_OPT}); %options = (map {$_ => $main::defaults->{$_}} keys %$main::defaults); GetOptions(\%options, @getoptconf) || bailout(); $options{hostname} = $ARGV[0] if scalar @ARGV; } sub commandline { bailout() if exists $options{help}; if (exists $options{version}) { print "nas version $VERSION\n"; exit(0); } if (exists $options{verbose}) { $ENV{NCI_LOG_AT} = $options{verbose}; } # checks for incompatible/nonsense command option combinations bailout("error: Cannot Record (-R) and Playback (-P) at the same time.\n") if $options{record} and $options{playback}; bailout("error: Record needs either command log file (-l) or script name (-s).\n") if $options{record} and not ($options{script} or $options{cmdlog}); bailout("error: Makes no sense to have both command log file (-l) and script (-s).\n") if $options{cmdlog} and $options{script}; bailout("error: Please specify hostname or IP on command line if recording.\n") if $options{record} and not $options{hostname}; # hello there, user print $banner if not exists $options{quiet}; # login credentials if (not exists $options{cloginrc}) { if (not exists $options{username}) { $options{username} = prompt('Username:', $ENV{USER}); } if (not exists $options{nopassword}) { $options{password} = read_password(colored ['white'], 'Password (optional): '); bailout("error: No login password and no cloginrc (-c) file (need -z ?).\n") if not length $options{password}; } } } sub get_creds_from_cloginrc { return unless $options{cloginrc} and -e $options{cloginrc}; open my $cloginrc, '<', $options{cloginrc} or bailout("$!\n"); my %t_map = (telnet => 'Telnet', 'ssh' => 'SSH'); my @find = qw(autoenable method timeout user password); my %found = (map {$_ => 0} @find); while (<$cloginrc>) { my $line = $_; next unless defined $line and length $line and $line =~ m/^add /; foreach my $f (@find) { next unless $line =~ m/^add\s+$f\s+(\S+)\s+(\S+)(?:\s+(\S+))?/; my ($host, $value, $value2) = ($1, $2, $3); next unless match_glob($host, $options{hostname}); next if $found{$f}++; if ($f eq 'autoenable') { $options{cloginrc_opts}{do_privileged_mode} = not $value; } elsif ($f eq 'method') { $options{cloginrc_opts}{transport} = $t_map{$value} if not exists $options{transport}; } elsif ($f eq 'timeout') { $options{cloginrc_opts}{timeout} = $value; } elsif ($f eq 'user') { $options{cloginrc_opts}{username} = $value if not exists $options{username}; } elsif ($f eq 'password') { $options{cloginrc_opts}{password} = $value; $options{cloginrc_opts}{privileged_password} = $value2 if defined $value2 and length $value2; } } } } sub run { getopt(); commandline(); if (not exists $options{hostname}) { if (not exists $options{quiet}) { print colored ['green'], qq{Now looping, waiting for hostnames on standard input...\n}; } while (<>) { $options{hostname} = $_; chomp $options{hostname}; next if not length $options{hostname}; get_creds_from_cloginrc(); do_session(%options); } } else { do_session(%options); } exit($exit_status); } sub do_session { my (%options) = @_; # scripting sources my $script_read = IO::Handle->new(); my $command_log = IO::Handle->new(); if ($options{cmdlog}) { if ($options{playback}) { open $script_read, '<', $options{cmdlog}; if (not $options{quiet}) { print colored ['green'], "Playing back command log...\n"; } } elsif ($options{record}) { open $command_log, '>', $options{cmdlog}; if (not $options{quiet}) { print colored ['green blink'], "Recording command log!\n"; } } } if ($options{record} and $options{script}) { open $command_log, '>', $options{script}; open my $source, '<', abs_path($0); while (<$source>) { print $command_log $_ unless $_ =~ m/__END__/ } close $source; my %settings = (%options, playback => 1); delete $settings{$_} for qw/record script cmdlog password nopassword cloginrc_opts/; print $command_log "BEGIN {\n our "; print $command_log Data::Dumper->Dump([\%settings], ['defaults']); print $command_log "}\n\n"; print $command_log "__DATA__\n"; print colored ['green blink'], "Recording session!\n" if not $options{quiet}; } # informational messages if not in quiet mode if (not exists $options{quiet}) { my @messages = (); if (not exists $options{personality}) { push @messages, qq{personality "/cisco/ios"}; } if (not exists $options{transport} or not exists $options{cloginrc_opts}{transport}) { push @messages, 'transport SSH'; } if (scalar @messages) { print colored ['green'], 'Assuming '. (join ' and ', @messages), ".\n"; } } print colored ['white'], "Connecting to [$options{hostname}]...\n\n" if not $options{quiet}; my $s = Net::Appliance::Session->new({ host => $options{hostname}, transport => ($options{transport} || 'SSH'), personality => ($options{personality} || 'ios'), ($options{username} ? (username => $options{username}) : ()), ($options{password} ? (password => $options{password}) : ()), (($options{quiet} and ($options{transport} eq 'SSH' or $options{cloginrc_opts}{transport} eq 'SSH')) ? ( connect_options => { opts => ['-q'] }, ) : ()), %{ $options{cloginrc_opts} || {} }, }); if ($options{paging} or not ($s->nci->phrasebook->has_macro('enable_paging') or $s->nci->phrasebook->has_macro('paging'))) { $s->do_paging(0); } try { $s->connect(); print $s->last_response if not $options{nobanner}; while (1) { my $cmd = get_next_cmd($s, $script_read); last if not defined $cmd; next if $cmd =~ m/^\s+$/; if ($command_log->opened) { print $command_log "$cmd\n"; $command_log->flush; } if ($cmd =~ m/^!m\s+(\S+)(?:\s+(.+))?/) { my ($name, $args) = ($1, $2); $args = '' if not defined $args; print colored ['white bold'], "Running macro [$name]...\n" if not $options{quiet}; $s->macro($name, { params => [split /\s+/, $args] }); next; } elsif ($cmd =~ m/^!m/) { print colored ['white bold'], "Macro Names:\n"; foreach my $m ($s->nci->phrasebook->macro_names) { print colored ['white bold'], " $m\n"; } next; } elsif ($cmd =~ m/^!s\s+(\S+)/) { my $call = $1; if (not $s->can($call)) { print colored ['red bold'], "NAS cannot do [$call]\n"; } else { print colored ['white bold'], "Running session call [$call]...\n" if not $options{quiet}; $s->$call; last if not $s->logged_in; } next; } elsif ($cmd =~ m/^\\!m/) { $cmd =~ s/^\\//; } my @last_response = $s->cmd($cmd); $exit_status = scalar @last_response if $options{'exit-last'}; print join '', @last_response; } } catch { print colored ['white bold'], $_; } finally { $s->close; }; } sub get_next_cmd { my ($s, $script_read) = @_; my $turtle = colored ['red'], '>> '; if ($options{playback}) { no warnings 'once'; my $cmd = ($options{cmdlog} ? <$script_read> : ); return if not defined $cmd; chomp $cmd; print $turtle, $s->nci->last_prompt, $cmd, "\n" if not $options{echo}; return $cmd; } else { prompt($turtle . $s->last_prompt); } } 1; Net-Appliance-Session-4.200002/lib/Net/Appliance/Session/Transport.pm000644 000765 000024 00000006645 12715670416 025636 0ustar00oliverstaff000000 000000 package Net::Appliance::Session::Transport; { $Net::Appliance::Session::Transport::VERSION = '4.142720'; } { package # hide from pause Net::Appliance::Session::Transport::ConnectOptions; use Moo; use MooX::Types::MooseLike::Base qw(Str); has username => ( is => 'ro', isa => Str, required => 0, predicate => 1, ); has password => ( is => 'ro', isa => Str, required => 0, predicate => 1, ); has privileged_password => ( is => 'ro', isa => Str, required => 0, predicate => 1, ); } use Moo::Role; sub connect { my $self = shift; my $options = Net::Appliance::Session::Transport::ConnectOptions->new(@_); foreach my $slot (qw/ username password privileged_password /) { my $has = 'has_' . $slot; my $set = 'set_' . $slot; $self->$set($options->$slot) if $options->$has; } if ($self->nci->transport->is_win32 and $self->has_password) { $self->set_password($self->get_password . $self->nci->transport->ors); } # SSH transport takes a username if we have one $self->nci->transport->connect_options->username($self->get_username) if $self->has_username and $self->nci->transport->connect_options->can('username'); # poke remote device (whether logging in or not) $self->find_prompt($self->wake_up); # optionally, log in to the remote host if ($self->do_login and not $self->prompt_looks_like('generic')) { if ($self->nci->phrasebook->has_prompt('user') and $self->prompt_looks_like('user')) { die 'a set username is required to connect to this host' if not $self->has_username; $self->cmd($self->get_username, { match => 'pass' }); } die 'a set password is required to connect to this host' if not $self->has_password; # support for serial console servers where, after loggin in to the # server, the console is asleep and needs waking up to show its prompt $self->say($self->get_password); $self->find_prompt($self->wake_up); } $self->prompt_looks_like('generic') or die 'login failed to remote host - prompt does not match'; $self->close_called(0); $self->logged_in(1); $self->in_privileged_mode( $self->do_privileged_mode ? 0 : 1 ); $self->in_configure_mode( $self->do_configure_mode ? 0 : 1 ); # disable paging... this is undone in our close() method $self->disable_paging if $self->do_paging; return $self; } sub close { my $self = shift; # protect against death spiral (rt.cpan #53796) return if $self->close_called; $self->close_called(1); if ($self->nci->transport->connect_ready) { $self->end_configure if $self->do_configure_mode and $self->in_configure_mode; $self->end_privileged if $self->do_privileged_mode and $self->in_privileged_mode; # re-enable paging $self->enable_paging if $self->do_paging; # issue disconnect macro if the phrasebook has one if ($self->nci->phrasebook->has_macro('disconnect')) { eval { $self->macro('disconnect') }; # this should die as there's no returned prompt (NCI pump() fails) } $self->nci->transport->disconnect; # there is no longer a transport } $self->logged_in(0); } 1; Net-Appliance-Session-4.200002/examples/example-1.pl000644 000765 000024 00000003206 12715670416 022423 0ustar00oliverstaff000000 000000 #!/usr/bin/perl -n # This (fictional) example shows how you can save time if there are many # devices that require manual login reconfiguration (e.g. no SNMP). # # The program is a filter, so wants a list of hosts on standard input or a # filename containing hosts as an argument, and will go through each one, # connecting to and reconfiguring the device. BEGIN { use strict; use warnings FATAL => 'all'; use Net::Appliance::Session; } my $host = $_; chomp $host; die "one and only param is a device FQDN or IP!\n" if ! defined $host; my $s = Net::Appliance::Session->new({ transport => 'SSH', # or 'Telnet' or 'Serial' personality => 'ios', # or many others, see docs host => $host, }); $s->set_global_log_at('notice'); # maximum debugging is 'debug' try { $s->connect({ name => $username, password => $password, }); $s->begin_privileged; # use same pass as login # is this a device with FastEthernet or GigabitEthernet ports? # let's do a test and find out, for use in the later commands. my $type = $s->cmd('show interfaces status | incl 1/0/24'); $type = ($type =~ m/^Gi/ ? 'GigabitEthernet' : 'FastEthernet'); # now actually do some work... # (lines which make changes are commented in this example!) $s->begin_configure; $s->cmd("interface ${type}1/0/13"); # $s->cmd('no shutdown'); $s->cmd("interface ${type}1/0/14"); # $s->cmd('no shutdown'); $s->cmd("interface ${type}1/0/15"); # $s->cmd('no shutdown'); $s->end_configure; # $s->cmd('write memory'); $s->end_privileged; } catch { warn $_; } finally { $s->close; }; Net-Appliance-Session-4.200002/bin/nas000755 000765 000024 00000010454 12717072262 017736 0ustar00oliverstaff000000 000000 #!perl use strict; use warnings FATAL => 'all'; use Net::Appliance::Session::Scripting; Net::Appliance::Session::Scripting::run(); # ABSTRACT: Create Reusable Session Scripts # PODNAME: nas __END__ =pod =head1 NAME nas - Create Reusable Session Scripts =head1 VERSION version 4.142720 =head1 SYNOPSIS $ nas --help nas [options] [hostname or IP] -p, --personality Device (default: "ios") -t, --transport method (Serial, Telnet, default: SSH) -u, --username to connect as on device (default: $USER) -R, --record Record session -P, --playback Play back session -s, --script When recording, save playback script to this -l, --cmdlog NAS to record commands to, or play them back from -e, --exit-last Num. of output lines from last command is program exit status -c, --cloginrc RANCID cloginrc with device credentials -z, --nopassword Do not ask for device password (if not using cloginrc) -o, --echo Echo commands sent, when playing back the recorded script/cmdlog -M, --paging Do not attempt to disable command output paging -B, --nobanner Suppress display of any login banner received from the device -q, --quiet Hide informational messages -v, --verbose NCI log ("debug", "notice", "info", etc) -V, --version Display this program's version number -h, --help Display this help text =head1 DESCRIPTION Use this program to help write reusable L scripts, play them back, and also to more easily connect to network devices. =over 4 =item * Start a connection to a network device using CLI switches, and prompts for credentials. This is easier than writing short Perl programs. =item * Record a set of commands issued to one network device into a command log, then replay that log against other devices (C<< -R -l >> and C<< -P -l >>). =item * Record a session and produce a Perl script which when run, replays the session to the same host, or overridable to other devices (C<< -R -s