SNMP::...oConfig(3pm)

📦

version 3.975000 · 8 versions

3.975000 · ubuntu stonking (latest)
3.974.0 · fedora 43
3.81 · ubuntu jammy
3.975.0 · fedora 44
3.95 · ubuntu noble
3.92 · debian bookworm
3.974000 · ubuntu resolute
3.972002 · debian trixie, ubuntu questing

💖 SNMP::Info::CiscoConfig 💖

okay bestie so this is a page from the User Contributed Perl Documentation, and it's section 3pm of the manual, and the module itself is called SNMP::Info::CiscoConfig. it's a manpage. it's perl. it's giving network admin realness. let's go 🫶

✨ NAME ✨

SNMP::Info::CiscoConfig — an SNMP interface to Cisco configuration files, i.e. the thing that lets you poke at your switch's config from Perl instead of, like, physically being there. iconic behavior honestly.

🎀 AUTHOR 🎀

Justin Hunter, Eric Miller. say thank you 👑✨

🌸 SYNOPSIS 🌸

here's the whole vibe, verbatim, no cap:

my $ciscoconfig = new SNMP::Info(
                      AutoSpecify => 1,
                      Debug       => 1,
                      DestHost    => 'myswitch',
                      Community   => 'public',
                      Version     => 2
                    )

or die "Can't connect to DestHost.\n";

my $class = $ciscoconfig->class();
print " Using device sub class : $class\n";

okay and also, <italic>or die</italic> when you can't connect, bestie. that part matters. the die is not optional energy. 💀

🦋 DESCRIPTION 🦋

so SNMP::Info::CiscoConfig is a subclass of SNMP::Info, and what it does is give you an interface to three whole MIBs:

CISCO-CONFIG-COPY-MIB
CISCO-FLASH-MIB
OLD-CISCO-SYS-MIB

and these MIBs are the ones that make writing configuration files possible. that's the whole point. that's the assignment. ✨

bestie, listen: use or create a subclass of SNMP::Info that inherits this one. do NOT use it directly. that's not a suggestion, that's the rule. 🙈

Inherited Classes

None. zero. empty. it inherits nothing extra, it's standing on its own two feet. 💅

Required MIBs

CISCO-CONFIG-COPY-MIB
CISCO-FLASH-MIB
OLD-CISCO-SYS-MIB

⭐ GLOBALS ⭐

these are methods that return a scalar value straight from SNMP. pure single-value energy.

$ciscoconfig->old_write_mem() — maps to "writeMem".
$ciscoconfig->old_write_net() — maps to "writeNet".

💜 TABLE METHODS 💜

these are methods that return whole tables of info, and they hand it back to you as a reference to a hash. a hash! a big ol' hash. 🍓

Config Copy Request Table (`"ccCopyTable"`)

$ciscoconfig->config_protocol() — maps to "ccCopyProtocol".
$ciscoconfig->config_source_type() — maps to "ccCopySourceFileType".
$ciscoconfig->config_dest_type() — maps to "ccCopyDestFileType".
$ciscoconfig->config_server_addr() — maps to "ccCopyServerAddress".
$ciscoconfig->config_filename() — maps to "ccCopyFileName".
$ciscoconfig->config_username() — maps to "ccCopyUserName".
$ciscoconfig->config_password() — maps to "ccCopyUserPassword".
$ciscoconfig->config_notify_complete() — maps to "ccCopyNotificationOnCompletion".
$ciscoconfig->config_copy_state() — maps to "ccCopyState".
$ciscoconfig->config_copy_start_time() — maps to "ccCopyTimeStarted".
$ciscoconfig->config_copy_complete_time() — maps to "ccCopyTimeCompleted".
$ciscoconfig->config_fail_cause() — maps to "ccCopyFailCause".
$ciscoconfig->config_row_status() — maps to "ccCopyEntryRowStatus".

Flash Copy Table (`"ciscoFlashCopyTable"`)

it's a table of Flash copy operation entries. flash copy. entries. you got it. 🌈

$ciscoconfig->flash_copy_cmd() — maps to "ciscoFlashCopyCommand".
$ciscoconfig->flash_copy_protocol() — maps to "ciscoFlashCopyProtocol".
$ciscoconfig->flash_copy_address() — maps to "ciscoFlashCopyServerAddress".
$ciscoconfig->flash_copy_source() — maps to "ciscoFlashCopySourceName".
$ciscoconfig->flash_copy_dest() — maps to "ciscoFlashCopyDestinationName".
$ciscoconfig->flash_copy_row_status() — maps to "ciscoFlashCopyEntryStatus".

👑 SET METHODS 👑

these are the methods that actually give you SNMP set functionality — either for methods that got overridden, or as a way simpler interface to set operations that are honestly kinda complex. for the general lore on set operations, go read "SETTING DATA VIA SNMP" in SNMP::Info. 📚

$ciscoconfig->copy_run_tftp (tftpserver, tftpfilename ) — stores the running configuration onto a TFTP server. it's equivalent to the CLI commands copy running-config tftp or write net.

here's the tea on how it works: this method tries the newer copy running-config tftp procedure first, and only falls back to the older write net procedure if that fails. the newer procedure is supported by Cisco devices that have the CISCO-CONFIG-COPY-MIB available — that's Cisco IOS software release 12.0, or on some devices as early as release 11.2P. the older procedure has been depreciated by Cisco and only exists to support devices running older code revisions. (depreciated! watch out. 👀)

Example, verbatim:

$ciscoconfig->copy_run_tftp('1.2.3.4', 'myconfig')
   or die "Couldn't save config. ",$ciscoconfig->error(1);

$ciscoconfig->copy_run_start() — copies the running configuration over to the startup configuration. equivalent to the CLI command copy running-config startup-config or write mem.

same energy as above: it tries the newer copy running-config startup-config procedure first, then falls back to the older write mem procedure if that fails. the newer one needs Cisco devices with the CISCO-CONFIG-COPY-MIB available, Cisco IOS software release 12.0, or on some devices as early as release 11.2P. the older procedure has been depreciated by Cisco and is only there to support devices on older code revisions. ✨