<<

NAME

pf::Switch::constants - Constants for SNMP to be consumed by SNMP modules

DESCRIPTION

This file is splitted by packages and refering to the constant requires you to specify the package.

SNMP

Defined by standards

ROLES

Required roles for every switch. Those are reserved words for any additional custom role.

VERSIONS

Supported SNMP versions by PacketFence

MAC_ADDRESS_FORMAT

snmptrapd guesses the format of data in traps. If the format is printable then it feeds it as a STRING. Otherwise an Hex-STRING is sent (99.9% of the cases).

We need to handle both cases thus this precompiled regexp.

dot1dTpFdbStatus - defined by RFC 1493 (Definitions of Managed Objects for Bridges)

 other(1)
 invalid(2)
 learned(3)
 self(4)
 mgmt(5)

TruthValue - defined by RFC 1903 (SNMP Textual Conventions) aka SNMPv2-TC

 true (1)
 false (2)

RowStatus - defined by RFC 2579 (Textual Conventions for SMIv2)

 active (1)
 notInService (2)
 notReady (3)
 createAndGo (4)
 createAndWait (5)
 destroy (6)

ifAdminStatus - defined by RFC 2863 (Interfaces Group) aka IF-MIB

 up(1),        -- ready to pass packets
 down(2),
 testing(3),   -- in some test mode

ifOperStatus - defined by RFC 2863 (Interfaces Group) aka IF-MIB

 up(1),        -- ready to pass packets
 down(2),
 testing(3),   -- in some test mode
 unknown(4),   -- status can not be determined for some reason.
 dormant(5),
 notPresent(6),    -- some component is missing
 lowerLayerDown(7) -- down due to state of lower-layer interface(s)

ifType - defined by RFC 2863 (Interfaces Group) aka IF-MIB

There are a lot of ifTypes, only a few of interest to PacketFence were copied here. Check http://www.iana.org/assignments/ianaiftype-mib for the full list.

 ...
 ethernetCsmacd(6),
 ...
 gigabitEthernet (117), Obsoleted via RFC3635. ethernetCsmacd (6) should be used instead
 ...

Working modes

Working modes of a switch

Deauth type method

Deauth type method constant

Deauth type method

List of available deauth type methods

Q-BRIDGE

RFC 4363: Definitions of Managed Objects for Bridges with Traffic Classes, Multicast Filtering, and Virtual LAN Extensions

dot1qStaticUnicastStatus

 other(1)
 invalid(2)
 permanent(3)
 deleteOnReset(4)
 deleteOnTimeout(5)

LLDP

LldpSystemCapabilitiesMap

Defined by IEEE 802.1AB. Values below from LLDP-MIB.

 other(0),
 repeater(1),
 bridge(2),
 wlanAccessPoint(3),
 router(4),
 telephone(5),
 docsisCableDevice(6),
 stationOnly(7)

CISCO

Cisco constants

cpsIfViolationAction - Action to take in case of port-security violation (from CISCO-PORT-SECURITY-MIB)

 Shutdown (1)
 DropNotify (2)
 Drop (3)

ConfigFileType

Various configuration-related source files or target files. Used by ccCopySourceFileType and ccCopyDestFileType. From CISCO-CONFIG-COPY MIB.

  networkFile(1),
  iosFile(2),
  startupConfig(3),
  runningConfig(4),
  terminal(5),
  fabricStartupConfig(6)

NAS-Port constants

Used for NAS-Port to ifIndex translation

LLDP constants

lldpRemTimeMark is always set to 0 on Cisco's (at least those we tried)

Trunk encapsulation constants

Used to set the encapsulation of a trunk

EXTREME

Extreme Networks constants

PORT_SECURITY_DETECT_VLAN

Special VLAN used to detect if locked-learning is activated or not. Used for isPortSecurityEnabled()

Web Services constants - constants related to Extreme's Web Services functionality

 WS_TIMEOUT - Timeout value for Web Services operations
 WS_PROXY_URI_PATH - Common path for Extreme's Web Services operations
 WS_NAMESPACE_FDB - Namespace for the Fdb table operations
 WS_PREFIX_XOS - Prefix for XOS APIs
 WS_DATATYPE_MAC - MAC address datatype
 WS_DATATYPE_VLAN - VLAN datatype
 WS_DATATYPE_PORT - Port datatype
 WS_CREATE_FDB - Create Fdb Entry method call
 WS_DELETE_FDB - Delete Fdb Entry method call
 WS_GET_ALL_FDB - Get All Fdb Entries method call
 WS_NODE_ALL_FDB_RESPONSE - Tree structure that gets to the Fdb contents

EXTREME::VLAN

Extreme Networks VLAN oriented constants

extremeVlanOpaqueControlOperation - Operations on VLANs (from EXTREME-VLAN-MIB)

 addTagged(1)
 addUntagged(2)
 delete(3)

NORTEL

Nortel constants

rcVlanPortType - Port types (from RC-VLAN-MIB)

  access(1),
  trunk(2)

Note: Documentation is incomplete other values were found empirically.

HP

HP ProCurve constants

coDevWirCliDisassociate - Disassociate the wireless client (from COLUBRIS-DEVICE-WIRELESS-MIB)

 idle(0),
 disassociate(1)

THREECOM

3Com constants

hwdot1qTpFdbSetStatus

 other(1),
 learned(3),
 static(6),
 dynamic(7),
 blackhole(9),
 security(11)

hwdot1qTpFdbSetOperate

 add(1),
 delete(2)

NAS-Port constants

Used for NAS-Port to ifIndex translation

BROCADE

Brocade constants

dot1xPaePortReauthenticate - 802.1x Port state (from brcdlp)

  force_unauthorized(1),
  controlauto(2)

Note: Documentation is incomplete other values were found empirically.

AEROHIVE

AeroHive constants

ahConnectionChangeEvent - Roaming change (from ah_trp_mib)

ahAPId, ahAPName, ahObjectName, ahIfIndex, -- Interface index detecting the client/neighbor ahObjectType, -- Client connection or neighbor connection ahRemoteId, -- MAC addr for the client or neighbour ahCurrentState, -- up, or down. ahSSID, -- ssid of the client is using if remoteid is a client ahCLientIP, -- Client IP address if the remote id is a client ahClientHostName, -- Client Host Name if the remote id is a client ahClientUserName, -- Client User Name if the remote id is a client ahClientAuthMethod, -- The authentication method the client uses to communicate with the HiveAP ahClientEncryptionMethod, -- The encryption method the client uses to communicate with the HiveAP ahClientMACProtocol, -- The radio mode the client uses to communicate with the HiveAP ahClientVLAN, -- The VLAN used by client to communicate with the HiveAP ahClientUserProfId, -- The user profile id used by client to communicate with the HiveAP ahClientChannel, -- The radio channel used by client to communicate with the HiveAP ahClientCWPUsed, -- The boolean indicating whether Captive Web Portal is used ahBSSID, -- Basic Service Set Identifier of the client is using if remoteid is a client. ahAssociationTime, -- The association time(s) of client connect or disconnect to AP. ahIfName, -- The interface name of client connect or disconnect to AP. ahCode, ahTrapDesc

AUTHOR

Inverse inc. <info@inverse.ca>

COPYRIGHT

Copyright (C) 2005-2015 Inverse inc.

LICENSE

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

<<