---
name: "SNMP::Info::CiscoPortSecurity"
section: "3pm"
platform: "linux"
package: "libsnmp-info-perl"
version: "3.972002-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/SNMP::Info::CiscoPortSecurity"
---

# SNMP::Info::CiscoPortSecurity(3pm)

SNMP Interface to data from CISCO-PORT-SECURITY-MIB, CISCO-PAE-MIB and CISCO-ERR-DISABLE-MIB.

## NAME

SNMP::Info::CiscoPortSecurity - SNMP Interface to data from CISCO-PORT-SECURITY-MIB, CISCO-PAE-MIB and CISCO-ERR-DISABLE-MIB.

## AUTHOR

Eric Miller

## SYNOPSIS

```
 # Let SNMP::Info determine the correct subclass for you.
 my $cps = new SNMP::Info(
                        AutoSpecify => 1,
                        Debug       => 1,
                        DestHost    => 'myswitch',
                        Community   => 'public',
                        Version     => 2
                        )
    or die "Can't connect to DestHost.\n";
 my $class      = $cps->class();
 print "SNMP::Info determined this device to fall under subclass : $class\n";
```

## DESCRIPTION

SNMP::Info::CiscoPortSecurity is a subclass of SNMP::Info that provides an interface to the *CISCO-PORT-SECURITY-MIB*, *CISCO-PAE-MIB* and *CISCO-ERR-DISABLE-MIB*. These MIBs are used across the Catalyst family under CatOS and IOS.

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

### Inherited Classes

None.

### Required MIBs

- *CISCO-PORT-SECURITY-MIB*

  - *CISCO-PAE-MIB*

  - *IEEE8021-PAE-MIB*

  - *CISCO-ERR-DISABLE-MIB*

  ## GLOBALS

These are methods that return scalar values from SNMP

### *CISCO-PORT-SECURITY-MIB* globals

- $cps-\>**cps\_clear()**

  (`"cpsGlobalClearSecureMacAddresses"`)

- $cps-\>**cps\_notify()**

  (`"cpsGlobalSNMPNotifControl"`)

- $cps-\>**cps\_rate()**

  (`"cpsGlobalSNMPNotifRate"`)

- $cps-\>**cps\_enable()**

  (`"cpsGlobalPortSecurityEnable"`)

- $cps-\>**cps\_mac\_count()**

  (`"cpsGlobalTotalSecureAddress"`)

- $cps-\>**cps\_mac\_max()**

  (`"cpsGlobalMaxSecureAddress"`)

## TABLE METHODS

### "CISCO-PORT-SECURITY-MIB" - Interface Config Table

- $cps-\>**cps\_i\_limit\_val()**

  (`"cpsIfInvalidSrcRateLimitValue"`)

- $cps-\>**cps\_i\_limit()**

  (`"cpsIfInvalidSrcRateLimitEnable"`)

- $cps-\>**cps\_i\_sticky()**

  (`"cpsIfStickyEnable"`)

- $cps-\>**cps\_i\_clear\_type()**

  (`"cpsIfClearSecureMacAddresses"`)

- $cps-\>**cps\_i\_shutdown()**

  (`"cpsIfShutdownTimeout"`)

- $cps-\>**cps\_i\_flood()**

  (`"cpsIfUnicastFloodingEnable"`)

- $cps-\>**cps\_i\_clear()**

  (`"cpsIfClearSecureAddresses"`)

- $cps-\>**cps\_i\_mac()**

  (`"cpsIfSecureLastMacAddress"`)

- $cps-\>**cps\_i\_count()**

  (`"cpsIfViolationCount"`)

- $cps-\>**cps\_i\_action()**

  (`"cpsIfViolationAction"`)

- $cps-\>**cps\_i\_mac\_static()**

  (`"cpsIfStaticMacAddrAgingEnable"`)

- $cps-\>**cps\_i\_mac\_type()**

  (`"cpsIfSecureMacAddrAgingType"`)

- $cps-\>**cps\_i\_mac\_age()**

  (`"cpsIfSecureMacAddrAgingTime"`)

- $cps-\>**cps\_i\_mac\_count()**

  (`"cpsIfCurrentSecureMacAddrCount"`)

- $cps-\>**cps\_i\_mac\_max()**

  (`"cpsIfMaxSecureMacAddr"`)

- $cps-\>**cps\_i\_status()**

  (`"cpsIfPortSecurityStatus"`)

- $cps-\>**cps\_i\_enable()**

  (`"cpsIfPortSecurityEnable"`)

### "CISCO-PORT-SECURITY-MIB::cpsIfVlanTable"

- $cps-\>**cps\_i\_v\_mac\_count()**

  (`"cpsIfVlanCurSecureMacAddrCount"`)

- $cps-\>**cps\_i\_v\_mac\_max()**

  (`"cpsIfVlanMaxSecureMacAddr"`)

### "CISCO-PORT-SECURITY-MIB::cpsIfVlanSecureMacAddrTable"

- $cps-\>**cps\_i\_v\_mac\_status()**

  (`"cpsIfVlanSecureMacAddrRowStatus"`)

- $cps-\>**cps\_i\_v\_mac\_age()**

  (`"cpsIfVlanSecureMacAddrRemainAge"`)

- $cps-\>**cps\_i\_v\_mac\_type()**

  (`"cpsIfVlanSecureMacAddrType"`)

### "CISCO-PORT-SECURITY-MIB::cpsSecureMacAddressTable"

- $cps-\>**cps\_m\_status()**

  (`"cpsSecureMacAddrRowStatus"`)

- $cps-\>**cps\_m\_age()**

  (`"cpsSecureMacAddrRemainingAge"`)

- $cps-\>**cps\_m\_type()**

  (`"cpsSecureMacAddrType"`)

### "IEEE8021-PAE-MIB::dot1xPaePortEntry"

- $cps-\>**pae\_i\_capabilities()**

  `"dot1xPaePortCapabilities"`

  Indicates the PAE functionality that this Port supports and that may be managed through this MIB munged to return either `'dot1xPaePortAuthCapable'` or `'dot1xPaePortSuppCapable'`.

- $cps-\>**pae\_i\_last\_eapol\_frame\_source()**

  `"dot1xAuthLastEapolFrameSource"`

  The source MAC address carried in the most recently received EAPOL frame.

### "CISCO-ERR-DISABLE-MIB::cErrDisableIfStatusEntry"

- $cps-\>**cerr\_i\_cause()**

  `"cErrDisableIfStatusCause"`

  Indicates the feature/event that caused the {interface, vlan} (or the entire interface) to be error-disabled.

## METHODS

- "i\_err\_disable\_cause"

  Returns a HASH reference mapping ifIndex to err-disabled cause. The returned data is sparse, so if the ifIndex is not present in the return value, the port is not err-disabled.

## Data Munging Callback Subroutines

- $cps-\>**munge\_pae\_capabilities()**

  Return either `'dot1xPaePortAuthCapable'` or `'dot1xPaePortSuppCapable'` based upon bit value.