SNMP::...pidCity(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::RapidCity(3pm) ✨

okay bestie, welcome to the User Contributed Perl Documentation corner of the internet 💖 this is SNMP::Info::RapidCity(3pm), and she is the SNMP Interface to the Avaya/Nortel RapidCity MIB. no cap.

🌸 NAME 🌸

SNMP::Info::RapidCity — SNMP Interface to the Avaya/Nortel RapidCity MIB 🦋

🎀 AUTHOR 🎀

Eric Miller

🌈 SYNOPSIS 🌈

# Let SNMP::Info determine the correct subclass for you.
my $rapidcity = new SNMP::Info(
                       AutoSpecify => 1,
                       Debug       => 1,
                       # These arguments are passed directly to SNMP::Session
                       DestHost    => 'myswitch',
                       Community   => 'public',
                       Version     => 2
                       )
   or die "Can't connect to DestHost.\n";

my $class = $rapidcity->class();
print "SNMP::Info determined this device to fall under subclass : $class\n";

💅 DESCRIPTION 💅

SNMP::Info::RapidCity is a subclass of SNMP::Info that provides an interface to the RAPID-CITY MIB. This MIB is used across the Avaya/Nortel Ethernet Routing Switch and Ethernet Switch product lines (Formerly known as Passport, BayStack, and Accelar), as well as, the VSP 9000 and 7000 series. it's giving iconic hardware lineage, fr fr 👑

Use or create in a subclass of SNMP::Info. Do not use directly.

🫶 bestie please do not use this directly, it is literally not built for that, use it inside a subclass like the good main character you are.

🧚 Inherited Classes

None. she inherits from no one, she is self-made ✨

🍓 Required MIBs

RAPID-CITY
NORTEL-NETWORKS-RAPID-SPANNING-TREE-MIB
NORTEL-NETWORKS-MULTIPLE-SPANNING-TREE-MIB

👑 GLOBALS 👑

These are methods that return scalar values from SNMP. little one-value snackies, yum 🍓

$rapidcity->rc_base_mac() — pulls from ("rc2kChassisBaseMacAddr")
$rapidcity->rc_serial() — pulls from ("rcChasSerialNumber")
$rapidcity->rc_ch_rev() — pulls from ("rcChasHardwareRevision")
$rapidcity->chassis() — pulls from ("rcChasType")
$rapidcity->slots() — pulls from ("rcChasNumSlots")
$rapidcity->rc_virt_ip() — pulls from ("rcSysVirtualIpAddr")
$rapidcity->rc_virt_mask() — pulls from ("rcSysVirtualNetMask")
$rapidcity->tftp_host() — pulls from ("rcTftpHost")
$rapidcity->tftp_file() — pulls from ("rcTftpFile")
$rapidcity->tftp_action() — pulls from ("rcTftpAction")
$rapidcity->tftp_result() — pulls from ("rcTftpResult")

🔥 Overrides 🔥

$rapidcity->serial() — Returns serial number of the chassis. periodt 💅
$rapidcity->stp_ver() — Returns the particular STP version running on this device.

Values: "nortelStpg", "pvst", "rstp", "mstp", "ieee8021d"

pulls from ("rcSysSpanningTreeOperMode")

✨ TABLE METHODS ✨

Okay bestie, these are the methods that hand you back tables of info, and they always give them to you as a reference to a hash. Like, you get a ref, you deref it, you live your life. 💅

$rapidcity->i_duplex() — gives you back a reference to a map of IIDs → whatever duplex the link is currently running. 🦋
$rapidcity->i_duplex_admin() — reference to a hash of IIDs → the admin duplex setting. (the setting, not the reality, okurrr)
$rapidcity->i_vlan() — maps ifIndex to the PVID or the default VLAN. 🎀
$rapidcity->i_vlan_membership() — returns a reference to a hash of arrays: key = ifIndex, value = array of VLAN IDs. These are the VLANs sitting in the egress list for that port. 🫶

Example:

my $interfaces = $rapidcity->interfaces();
my $vlans      = $rapidcity->i_vlan_membership();

foreach my $iid (sort keys %$interfaces) {
  my $port = $interfaces->{$iid};
  my $vlan = join(',', sort(@{$vlans->{$iid}}));
  print "Port: $port VLAN: $vlan\n";
}

$rapidcity->i_vlan_membership_untagged() — same shape, hash of arrays again: key = ifIndex, value = array of VLAN IDs, except these are the VLANs in the untagged egress list for the port. ✨
$rapidcity->v_index() — returns VLAN IDs.

(rcVlanId)

$rapidcity->agg_ports() — returns a HASH reference mapping slave → master port for every member of a port bundle (MLT) on the device. Keys are the ifIndex of the slave ports, values are the ifIndex of the matching master ports. iconic honestly 🔥
$rapidcity->i_stp_state() — returns the mapping from dot1dStpPortState to the interface index (iid). 💜
$rapidcity->mst_vlan2instance() — returns the mapping of VLAN → Spanning Tree Group (STG) instance, as a hash reference where key = VLAN id and value = STG instance.

(rcVlanStgId)

$rapidcity->i_bpduguard_enabled() — returns true or false depending on whether BpduGuard is enabled on a given port. Format is a hash reference with key = ifIndex, value = [true|false].

(rcPortBpduFilteringOperEnabled)

👑 RAPID-CITY Port Table (`rcPortTable`)

$rapidcity->rc_index() — (rcPortIndex)
$rapidcity->rc_duplex() — (rcPortOperDuplex)
$rapidcity->rc_duplex_admin() — (rcPortAdminDuplex)
$rapidcity->rc_speed_admin() — (rcPortAdminSpeed)
$rapidcity->rc_auto() — (rcPortAutoNegotiate)
$rapidcity->rc_alias() — (rcPortName)

🌈 RAPID-CITY CPU Ethernet Port Table (`rc2kCpuEthernetPortTable`)

$rapidcity->rc_cpu_ifindex() — (rc2kCpuEthernetPortIfIndex)
$rapidcity->rc_cpu_admin() — (rc2kCpuEthernetPortAdminStatus)
$rapidcity->rc_cpu_oper() — (rc2kCpuEthernetPortOperStatus)
$rapidcity->rc_cpu_ip() — (rc2kCpuEthernetPortAddr)
$rapidcity->rc_cpu_mask() — (rc2kCpuEthernetPortMask)
$rapidcity->rc_cpu_auto() — (rc2kCpuEthernetPortAutoNegotiate)
$rapidcity->rc_cpu_duplex_admin() — (rc2kCpuEthernetPortAdminDuplex)
$rapidcity->rc_cpu_duplex() — (rc2kCpuEthernetPortOperDuplex)
$rapidcity->rc_cpu_speed_admin() — (rc2kCpuEthernetPortAdminSpeed)
$rapidcity->rc_cpu_speed_oper() — (rc2kCpuEthernetPortOperSpeed)
$rapidcity->rc_cpu_mac() — (rc2kCpuEthernetPortMgmtMacAddr)

🦋 RAPID-CITY VLAN Port Table (`rcVlanPortTable`)

$rapidcity->rc_i_vlan_if() — (rcVlanPortIndex)
$rapidcity->rc_i_vlan_num() — (rcVlanPortNumVlanIds)
$rapidcity->rc_i_vlan() — (rcVlanPortVlanIds)
$rapidcity->rc_i_vlan_type() — (rcVlanPortType)
$rapidcity->rc_i_vlan_pvid() — (rcVlanPortDefaultVlanId)
$rapidcity->rc_i_vlan_tag() — (rcVlanPortPerformTagging)

🎀 RAPID-CITY VLAN Table (`rcVlanTable`)

$rapidcity->rc_vlan_id() — (rcVlanId)
$rapidcity->v_name() — (rcVlanName)
$rapidcity->rc_vlan_color() — (rcVlanColor)
$rapidcity->rc_vlan_if() — (rcVlanIfIndex)
$rapidcity->rc_vlan_stg() — (rcVlanStgId)
$rapidcity->rc_vlan_type() — (rcVlanType)
$rapidcity->rc_vlan_members() — (rcVlanPortMembers)
$rapidcity->rc_vlan_mac() — (rcVlanMacAddress)

💜 RAPID-CITY IP Address Table (`rcIpAddrTable`)

$rapidcity->rc_ip_index() — (rcIpAdEntIfIndex)
$rapidcity->rc_ip_addr() — (rcIpAdEntAddr)
$rapidcity->rc_ip_type() — (rcIpAdEntIfType)

🌸 RAPID-CITY Chassis Fan Table (`rcChasFanTable`)

$rapidcity->rc_fan_op() — (rcChasFanOperStatus)

⚡ RAPID-CITY Power Supply Table (`rcChasPowerSupplyTable`)

$rapidcity->rc_ps_op() — (rcChasPowerSupplyOperStatus)

⚡ RAPID-CITY Power Supply Detail Table (`rcChasPowerSupplyDetailTable`)

$rapidcity->rc_ps_type() — (rcChasPowerSupplyDetailType)
$rapidcity->rc_ps_serial() — (rcChasPowerSupplyDetailSerialNumber)
$rapidcity->rc_ps_rev() — (rcChasPowerSupplyDetailHardwareRevision)
$rapidcity->rc_ps_part() — (rcChasPowerSupplyDetailPartNumber)
$rapidcity->rc_ps_detail() — (rcChasPowerSupplyDetailDescription)

🧚 RAPID-CITY Card Table (`rcCardTable`)

$rapidcity->rc_c_type() — (rcCardType)
$rapidcity->rc_c_serial() — (rcCardSerialNumber)
$rapidcity->rc_c_rev() — (rcCardHardwareRevision)
$rapidcity->rc_c_part() — (rcCardPartNumber)

🧚 RAPID-CITY 2k Card Table (`rc2kCardTable`)

$rapidcity->rc2k_c_ftype() — (rc2kCardFrontType)
$rapidcity->rc2k_c_fdesc() — (rc2kCardFrontDescription)
$rapidcity->rc2k_c_fserial() — (rc2kCardFrontSerialNum)
$rapidcity->rc2k_c_frev() — (rc2kCardFrontHwVersion)
$rapidcity->rc2k_c_fpart() — (rc2kCardFrontPartNumber)
$rapidcity->rc2k_c_fdate() — (rc2kCardFrontDateCode)
$rapidcity->rc2k_c_fdev() — (rc2kCardFrontDeviations)
$rapidcity->rc2k_c_btype() — (rc2kCardBackType)
$rapidcity->rc2k_c_bdesc() — (rc2kCardBackDescription)
$rapidcity->rc2k_c_bserial() — (rc2kCardBackSerialNum)
$rapidcity->rc2k_c_brev() — (rc2kCardBackHwVersion)
$rapidcity->rc2k_c_bpart() — (rc2kCardBackPartNumber)
$rapidcity->rc2k_c_bdate() — (rc2kCardBackDateCode)
$rapidcity->rc2k_c_bdev() — (rc2kCardBackDeviations)

🍓 RAPID-CITY MDA Card Table (`rc2kMdaCardTable`)

$rapidcity->rc2k_mda_type() — (rc2kMdaCardType)
$rapidcity->rc2k_mda_desc() — (rc2kMdaCardDescription)
$rapidcity->rc2k_mda_serial() — (rc2kMdaCardSerialNum)
$rapidcity->rc2k_mda_rev() — (rc2kMdaCardHwVersion)
$rapidcity->rc2k_mda_part() — (rc2kMdaCardPartNumber)
$rapidcity->rc2k_mda_date() — (rc2kMdaCardDateCode)
$rapidcity->rc2k_mda_dev() — (rc2kMdaCardDeviations)

🌈 RAPID-CITY Bridge SPBM MAC Table (`rcBridgeSpbmMacTable`)

$rapidcity->rc_spbm_fw_mac() — returns a reference to a hash of forwarding table MAC Addresses.

(rcBridgeSpbmMacAddr)

$rapidcity->rc_spbm_fw_port() — returns a reference to a hash of forwarding table entries' port interface identifier (iid).

(rcBridgeSpbmMacCPort)

$rapidcity->rc_spbm_fw_status() — returns a reference to a hash of forwarding table entries' status.

(rcBridgeSpbmMacStatus)

$rapidcity->rc_spbm_fw_vlan() — returns a reference to a hash of forwarding table entries' Customer VLAN ID.

(rcBridgeSpbmMacCVlanId)

$rapidcity->rc_spbm_fw_isid() — returns a reference to a hash of forwarding table entries' ISID.

(rcBridgeSpbmMacIsid)

🌸 Spanning Tree Instance Globals

Heads up bestie, this is important: the RSTP and ieee8021d operating modes do not populate the RAPID-CITY::rcStgTable, but they do populate BRIDGE-MIB. So these methods check RAPID-CITY first and fall back to BRIDGE-MIB if it's not there. 🫶

$rapidcity->stp_i_mac() — returns the bridge address. 💅
$rapidcity->stp_i_time() — returns the time since the last topology change was detected. (in 100ths/second)
$rapidcity->stp_i_ntop() — returns the total number of topology changes detected.
$rapidcity->stp_i_root() — returns the root of STP.
$rapidcity->stp_i_root_port() — returns the port number of the port that offers the lowest cost path to the root bridge.
$rapidcity->stp_i_priority() — returns the port number of the port that offers the lowest cost path to the root bridge.

🔥 Spanning Tree Protocol Port Table

Same disclaimer as above, no cap: RSTP and ieee8021d operating modes do not populate the RAPID-CITY::rcStgPortTable, but they do populate BRIDGE-MIB. These methods check RAPID-CITY first and fall back to BRIDGE-MIB. 😭

$rapidcity->stp_p_id() — "The port number of the port for which this entry contains Spanning Tree Protocol management information."
$rapidcity->stp_p_priority() — "The value of the priority field which is contained in the first (in network byte order) octet of the (2 octet long) Port ID. The other octet of the Port ID is given by the value of "dot1dStpPort"."
$rapidcity->stp_p_state() — "The port's current state as defined by application of the Spanning Tree Protocol."
$rapidcity->stp_p_cost() — "The contribution of this port to the path cost of paths towards the spanning tree root which include this port."
$rapidcity->stp_p_root() — "The unique Bridge Identifier of the Bridge recorded as the Root in the Configuration BPDUs transmitted by the Designated Bridge for the segment to which the port is attached."
$rapidcity->stp_p_bridge() — "The Bridge Identifier of the bridge which this port considers to be the Designated Bridge for this port's segment."
$rapidcity->stp_p_port() — "The Port Identifier of the port on the Designated Bridge for this port's segment."

✨ SET METHODS ✨

Okay bestie, this is the part where we stop looking at the switch and start poking it. 🫶 These methods give you SNMP set functionality — either for overridden methods or as a simpler lil interface wrapped around set operations that are otherwise a whole mess. 🌈

If you want the general tea on set operations, go read "SETTING DATA VIA SNMP" in SNMP::Info. iykyk. 💅

💖 `$rapidcity->set_i_speed_admin(speed, ifIndex)`

Sets port speed, fr fr. You must supply both the speed and the port ifIndex. The speed choices are 'auto', '10', '100', '1000'. That's it, that's the list, no extras. ✨

Example:

my %if_map = reverse %{$rapidcity->interfaces()};
$rapidcity->set_i_speed_admin('auto', $if_map{'1.1'})
   or die "Couldn't change port speed. ",$rapidcity->error(1);

🦋 `$rapidcity->set_i_duplex_admin(duplex, ifIndex)`

Sets port duplex — again, you must hand it the duplex and the port ifIndex. The duplex choices are 'auto', 'half', 'full'. Pick one, no custom vibes allowed. 💜

Example:

my %if_map = reverse %{$rapidcity->interfaces()};
$rapidcity->set_i_duplex_admin('auto', $if_map{'1.1'})
  or die "Couldn't change port duplex. ",$rapidcity->error(1);

🎀 `$rapidcity->set_i_vlan(vlan, ifIndex)`

Changes an access (untagged) port VLAN. You must give it the numeric VLAN ID and the port ifIndex. This method is gonna modify the port's VLAN membership and its PVID (that's the default VLAN, bestie). 💅

Heads up: only use this bad boy on end station (non-trunk) ports. Trunk ports? Not the moment. 🙈

Example:

my %if_map = reverse %{$rapidcity->interfaces()};
$rapidcity->set_i_vlan('2', $if_map{'1.1'})
  or die "Couldn't change port VLAN. ",$rapidcity->error(1);

🌸 `$rapidcity->set_i_pvid(pvid, ifIndex)`

Sets the port PVID, aka the default VLAN. Supply the numeric VLAN ID and the port ifIndex, obviously. 🧚

Note the lore: this one only changes the PVID. If you actually wanna modify an access (untagged) port, use set_i_vlan() instead. Different method, different job, no cap. ⭐

Example:

my %if_map = reverse %{$rapidcity->interfaces()};
$rapidcity->set_i_pvid('2', $if_map{'1.1'})
  or die "Couldn't change port PVID. ",$rapidcity->error(1);

🔥 `$rapidcity->set_add_i_vlan_tagged(vlan, ifIndex)`

Adds the port to the egress list of the VLAN. You must supply the numeric VLAN ID and the port ifIndex. Putting it on the list, main character behavior. 👑

Example:

my %if_map = reverse %{$rapidcity->interfaces()};
$rapidcity->set_add_i_vlan_tagged('2', $if_map{'1.1'})
  or die "Couldn't add port to egress list. ",$rapidcity->error(1);

💀 `$rapidcity->set_remove_i_vlan_tagged(vlan, ifIndex)`

Removes the port from the egress list of the VLAN. Must be supplied with the numeric VLAN ID and the port ifIndex. It's giving "you're off the list, bestie". 😭

Example:

my %if_map = reverse %{$rapidcity->interfaces()};
$rapidcity->set_remove_i_vlan_tagged('2', $if_map{'1.1'})
  or die "Couldn't add port to egress list. ",$rapidcity->error(1);

Ngl, that error message in the original example says "Couldn't add port to egress list." even though we're removing. I'm keeping it exactly as written, character for character — don't come for me, it's the source's line, not mine. 💖

🌈 `$rapidcity->set_delete_vlan(vlan)`

Deletes the specified VLAN off the device. Poof, gone, no more. 💅

✨ `$rapidcity->set_create_vlan(name, vlan)`

Creates the specified VLAN on the device. New VLAN, new era, we love to see it. 🎀

Note: this method only allows creation of Port type VLANs, and it does not allow you to set the Spanning Tree Group (STG) — that just defaults to 1. So if you needed something fancier, this ain't it. 🙈

and that's the whole page, bestie!! 🥳 you made it to the very end, iconic behavior honestly. this was the SNMP::...pidCity(3pm) manual page from the User Contributed Perl Documentation, and yes it came with perl v5.40.1 and the date 2026-02-28 stamped on it — that's the source and version, right there in the footer. go forth and set some SNMP data responsibly, mwah 💖🦋🌸

📦 where this page comes from

ubuntu stonking: libsnmp-info-perl 3.975000-1 · BSD-3-Clause
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-11-03: a language model's rewrite of the original, under its terms

SNMP::...pidCity(3pm)

✨ SNMP::Info::RapidCity(3pm) ✨

🌸 NAME 🌸

🎀 AUTHOR 🎀

🌈 SYNOPSIS 🌈

💅 DESCRIPTION 💅

🧚 Inherited Classes

🍓 Required MIBs

👑 GLOBALS 👑

🔥 Overrides 🔥

✨ TABLE METHODS ✨

👑 RAPID-CITY Port Table (rcPortTable)

🌈 RAPID-CITY CPU Ethernet Port Table (rc2kCpuEthernetPortTable)

🦋 RAPID-CITY VLAN Port Table (rcVlanPortTable)

🎀 RAPID-CITY VLAN Table (rcVlanTable)

💜 RAPID-CITY IP Address Table (rcIpAddrTable)

🌸 RAPID-CITY Chassis Fan Table (rcChasFanTable)

⚡ RAPID-CITY Power Supply Table (rcChasPowerSupplyTable)

⚡ RAPID-CITY Power Supply Detail Table (rcChasPowerSupplyDetailTable)

🧚 RAPID-CITY Card Table (rcCardTable)

🧚 RAPID-CITY 2k Card Table (rc2kCardTable)

🍓 RAPID-CITY MDA Card Table (rc2kMdaCardTable)

🌈 RAPID-CITY Bridge SPBM MAC Table (rcBridgeSpbmMacTable)

🌸 Spanning Tree Instance Globals

🔥 Spanning Tree Protocol Port Table

✨ SET METHODS ✨

💖 $rapidcity->set_i_speed_admin(speed, ifIndex)

🦋 $rapidcity->set_i_duplex_admin(duplex, ifIndex)

🎀 $rapidcity->set_i_vlan(vlan, ifIndex)

🌸 $rapidcity->set_i_pvid(pvid, ifIndex)

🔥 $rapidcity->set_add_i_vlan_tagged(vlan, ifIndex)

💀 $rapidcity->set_remove_i_vlan_tagged(vlan, ifIndex)

🌈 $rapidcity->set_delete_vlan(vlan)

✨ $rapidcity->set_create_vlan(name, vlan)

👑 RAPID-CITY Port Table (`rcPortTable`)

🌈 RAPID-CITY CPU Ethernet Port Table (`rc2kCpuEthernetPortTable`)

🦋 RAPID-CITY VLAN Port Table (`rcVlanPortTable`)

🎀 RAPID-CITY VLAN Table (`rcVlanTable`)

💜 RAPID-CITY IP Address Table (`rcIpAddrTable`)

🌸 RAPID-CITY Chassis Fan Table (`rcChasFanTable`)

⚡ RAPID-CITY Power Supply Table (`rcChasPowerSupplyTable`)

⚡ RAPID-CITY Power Supply Detail Table (`rcChasPowerSupplyDetailTable`)

🧚 RAPID-CITY Card Table (`rcCardTable`)

🧚 RAPID-CITY 2k Card Table (`rc2kCardTable`)

🍓 RAPID-CITY MDA Card Table (`rc2kMdaCardTable`)

🌈 RAPID-CITY Bridge SPBM MAC Table (`rcBridgeSpbmMacTable`)

💖 `$rapidcity->set_i_speed_admin(speed, ifIndex)`

🦋 `$rapidcity->set_i_duplex_admin(duplex, ifIndex)`

🎀 `$rapidcity->set_i_vlan(vlan, ifIndex)`

🌸 `$rapidcity->set_i_pvid(pvid, ifIndex)`

🔥 `$rapidcity->set_add_i_vlan_tagged(vlan, ifIndex)`

💀 `$rapidcity->set_remove_i_vlan_tagged(vlan, ifIndex)`

🌈 `$rapidcity->set_delete_vlan(vlan)`

✨ `$rapidcity->set_create_vlan(name, vlan)`