|
|
This chapter contains descriptions of the groups and variables used within the Cisco Management MIB files, including the following:
For information regarding other MIBs supported by the Catalyst 5000 series switch, refer to the Cisco Management Information Base (MIB) User Quick Reference publication.
This section contains descriptions of the groups and variables used for VLAN Membership Policy Server (VMPS) configurations within the Catalyst 5000 series switch CISCO-VMPS-MIB.
The CISCO-VMPS-MIB is used for the management of VLAN Membership within the Cisco VLAN Architecture framework. The CISCO-VMPS-MIB provides information on VMPS used by a device and VLAN membership assignments of nontrunk bridge ports of the device.
vmpsInfo (ciscoVlanMemberPolicyServerMIBObjects 1)
Information about a VMPS instance.
vmpsDatabase (ciscoVlanMemberPolicyServerMIBObjects 2)
Configuration information in use by a VMPS instance.
A table for creating and controlling an instance of the VMPS, and including the following variables: vmpsIndex, vmpsAdminStatus, vmpsDownloadServerAddress IpAddress, vmpsConfigFileName, vmpsTriggerDownload, vmpsFallbackVlan, vmpsSecureMode, vmpsManagementDomain, vmpsRowStatus.
Syntax: SEQUENCE OF VmpsConfigEntry
Access: Not accessible
vmpsConfigEntry (vmpsConfigTable 1)
An entry (conceptual row) in the vmpsConfigTable.
Syntax: VmpsConfigEntry
Access: Not accessible
An arbitrary index identifying this particular instance of the VMPS. This index does not need to be consistent across reboots. For devices only supporting one instance of the VMPS, this object needs only to accept the value of 1. Different instances of the VMPS of one device is presumed to be for different management domains.
Syntax: Integer32 (1..2147483647)
Access: Not accessible
vmpsAdminStatus (vmpsConfigEntry 2)
The desired state of the VMPS as prescribed by the operator. The actions of the agent will, if at all possible, eventually result in the desired state being reflected in the lecsOperStatus.
Syntax: INTEGER {
Access: Read-write
vmpsDownloadServerAddress (vmpsConfigEntry 3)
The IP address of the host supplying the Trivial File Transfer Protocol (TFTP) configuration data for the VMPS. If the value of this object is 0.0.0.0, then the VMPS will not attempt to download configuration information. Note that the operator can supply a broadcast address to solicit the configuration table from any available TFTP servers.
Syntax: IpAddress (default value is 00000000 H)
Access: Read-write
vmpsConfigFileName (vmpsConfigEntry 4)
The filename of the configuration file the VMPS will attempt to download.
Syntax: DisplayString (default is H)
Access: Read-write
vmpsTriggerDownload (vmpsConfigEntry 5)
When set to loadDatabase (2), this object causes the VMPS to initiate a TFTP download of the configuration tables stored at the host identified by the vmpsDownloadServerAddress. A download cannot be performed unless the host address is properly set. This object always returns noOperation (1) when read. Setting this object to loadDatabase (2) while the vmpsOperStatus is loading is effectively a no-operation.
Syntax: INTEGER {
Access: Read-write
vmpsFallbackVlan (vmpsConfigEntry 6)
This is the VLAN returned in the configuration response when a given configuration request contains data that matches nothing in the VMPS database (given the specified classifiers). A value of the empty string signifies that there is no fallback VLAN.
Syntax: VlanName (default is H)
Access: Read-write
vmpsSecureMode (vmpsConfigEntry 7)
If in secure mode the VMPS instructs the requesting device to shut down a port as a result of a match failure.
Syntax: INTEGER {
Access: Read-write
vmpsManagementDomain (vmpsConfigEntry 8)
The management domain this VMPS is servicing.
Syntax: DisplayString (SIZE (1..32))
Access: Read-write
vmpsRowStatus (vmpsConfigEntry 9)
The status of the conceptual row. A valid value of vmpsManagementDomain must be set before the row can become active. Devices that only support one instance of the VMPS can opt to always have a row in this table and not allow row manipulations.
Syntax: RowStatus
Access: Read-write
End of Table
Statistics relating to this instance of the VMPS.
Syntax: SEQUENCE OF VmpsStatsEntry
Access: Not accessible
vmpsStatsEntry (vmpsStatsTable 1)
An entry (conceptual row) in the vmpsStatsTable, which includes the following variables: vmpsLastRestart, vmpsInConfigReqs, vmpsInConfigErrors, vmpsOutConfigFails, vmpsLastFailClient MacAddress, vmpsOperStatus.
Syntax: VmpsStatsEntry
Access: Not accessible
vmpsLastRestart (vmpsStatsEntry 1)
The value of sysUpTime when the VMPS was last restarted.
Syntax: TimeStamp
Access: Read-only
vmpsInConfigReqs (vmpsStatsEntry 2)
The total number of configure requests, including vmpsInConfigErrors, that have been received by the VMPS.
Syntax: Counter32
Access: Read-only
vmpsInConfigErrors (vmpsStatsEntry 3)
The number of packets received by the VMPS which were not correctly formatted configure requests.
Syntax: Counter32
Access: Read-only
vmpsOutConfigFails (vmpsStatsEntry 4)
The number of configure responses sent by this particular VMPS whose status was other than success.
Syntax: Counter32
Access: Read-only
vmpsLastFailClient (vmpsStatsEntry 5)
The MAC address of the VLAN client whose last configuration request was rejected. This MAC address is for the VLAN client who delivered the last configure response that caused the vmpsOutConfigFails object to increment. This value is taken directly from the configure request and is not guaranteed to correctly identify a client.
Syntax: MacAddress
Access: Read-only
vmpsOperStatus (vmpsStatsEntry 6)
This object reflects the actual state of the VMPS which can differ from that of the vmpsAdminStatus object. This can occur when the configuration database fails to load but the corresponding vmpsAdminStatus is active (1).
Syntax: INTEGER {
Access: Read-only
End of Table
The Database Information group contains VMPS database information.
vmpsMacConfigTable (vmpsDatabase 1)
A (conceptual) table utilized by a VMPS to map the MAC address of an end station to a VLAN and includes the following variables: vmpsMacConfigAddress, vmpsMacConfigVlan, vmpsMacConfigLastAccessed, vmpsMacConfigLastRequestor, vmpsMacConfigLastRequestPortId, vmpsMacConfigLastResponseStatus, vmpsMacConfigStatus.
Syntax: SEQUENCE OF VmpsMacConfigEntry
Access: Not accessible
vmpsMacConfigEntry (vmpsMacConfigTable 1)
An entry (conceptual row) of a mapping between a MAC address in utilization by an end station and a VLAN.
Syntax: VmpsMacConfigEntry
Access: Not accessible
vmpsMacConfigAddress (vmpsMacConfigEntry 1)
The MAC address of an end station to be associated with a VLAN.
Syntax: MacAddress
Access: Not accessible
vmpsMacConfigVlan (vmpsMacConfigEntry 2)
A VLAN that will be returned to an end station that provides the corresponding MAC address in a configuration request. A zero length string indicates that the corresponding MAC address is not permitted on any VLANs, including the fallback.
Syntax: VlanName
Access: Read-write
vmpsMacConfigLastAccessed (vmpsMacConfigEntry 3)
The value of sysUpTime when this entry was last used to map a MAC address to a VLAN name. Managers can opt to use this object to discard entries that have not been used for a prolonged period of time.
Syntax: TimeStamp
Access: Read-only
vmpsMacConfigLastRequestor (vmpsMacConfigEntry 4)
The IP address of the device that requested the VLAN associated with the MAC of this row. The manager can use this object in an attempt to locate where a dynamic host currently resides.
Syntax: IpAddress
Access: Read-only
vmpsMacConfigLastRequestPortId (vmpsMacConfigEntry 5)
The ID of the port included in the configuration request that corresponded to the designated entry in this table.
Syntax: DisplayString
Access: Read-only
vmpsMacConfigLastResponseStatus (vmpsMacConfigEntry 6)
The value of the status field in the response for the last configure request for this MAC-address.
Syntax: Integer {
Access: Read-only
vmpsMacConfigStatus (vmpsMacConfigEntry 7)
The row cannot be set to active until an appropriate value exists for vmpsMacConfigVlan.
Syntax: RowStatus
Access: Read-write
End of Table
vmpsVlanConfigTable (vmpsDatabase 2)
A list of VLANs with restricted access from dynamic ports. This list takes the form of a group of VLANs and a group of ports permitted for those VLANs. If no entry exists for a particular VLAN, then there are no restrictions as to what ports are allowed to access that VLAN. If entries exist for a VLAN, then all ports not explicitly permitted for that VLAN are denied access (in the form of a failed configuration response). This table includes the following variables: vmpsVlanName, vmpsDeviceId, vmpsPortName, vmpsVlanConfigStatus.
Syntax: SEQUENCE OF VmpsVlanConfigEntry
Access: Not accessible
vmpsVlanConfigEntry (vmpsVlanConfigTable 1)
An entry (conceptual row) in the vmpsVlanConfigTable.
Syntax: VmpsVlanConfigEntry
Access: Not accessible
vmpsVlanName (vmpsVlanConfigEntry 1)
The VLAN name associated with a group of ports which are allowed access to that VLAN dynamically.
Syntax: VlanName
Access: Not accessible
vmpsDeviceId (vmpsVlanConfigEntry 2)
The IP address of the device containing the permitted ports.
Syntax: IP address
Access: Not accessible
vmpsPortName (vmpsVlanConfigEntry 3)
The ifName of the port on which dynamic access to the specified VLAN is allowed.
Syntax: DisplayString
Access: Not accessible
vmpsVlanConfigStatus (vmpsVlanConfigEntry 4)
The status object associated with the conceptual row.
Access: RowStatus
Access: Read-write
End of Table
This section contains descriptions of the groups and variables used for trunk port configurations within the Catalyst 5000 series switch CISCO-VTP-MIB.
vlanTrunkPorts (vtpMIBObjects 6)
Contains information on the local system's VLAN trunk ports.
vlanTrunkPortTable (vlanTrunkPorts 1)
Contains information on the local system's VLAN trunk ports, and includes the following variables: vlanTrunkPortIfIndex, vlanTrunkPortManagementDomain, vlanTrunkPortEncapsulationType, vlanTrunkPortVlansEnabled, vlanTrunkPortNativeVlan, vlanTrunkPortRowStatus, vlanTrunkPortInJoins, vlanTrunkPortOutJoins, vlanTrunkPortOldAdverts, vlanTrunkPortVlansPruningEligible, vlanTrunkPortVlansXmitJoined, vlanTrunkPortVlansRcvJoined.
Syntax: SEQUENCE OF VlanTrunkPortEntry
Access: Not accessible
vlanTrunkPortEntry (vlanTrunkPortTable 1)
Provides information about one trunk port.
Syntax: VlanTrunkPortEntry
Access: Not accessible
vlanTrunkPortIfIndex (vlanTrunkPortEntry 1)
Indicates the value of ifIndex for the interface corresponding to this trunk port.
Syntax: InterfaceIndex
Access: Not accessible
vlanTrunkPortManagementDomain (vlanTrunkPortEntry 2)
Indicates the value of managementDomainIndex for the management domain on this trunk port. Devices which support only one management domain support this object as read-only.
Syntax: ManagementDomainIndex
Access: Read-write
vlanTrunkPortEncapsulationType (vlanTrunkPortEntry 3)
Indicates the type of VLAN encapsulation used on this trunk port and whether writing to this object in order to modify the encapsulation is both device and interface specific.
Syntax: Integer {
Access: Read-only
vlanTrunkPortVlansEnabled (vlanTrunkPortEntry 4)
Indicates a string of octets containing one bit per VLAN in the management domain on this trunk port. The first octet corresponds to VLANs with VlanIndex values of 0 through 7, the second octet to VLANs 8 through 15, and so forth. The most significant bit of each octet corresponds to the lowest value VlanIndex in that octet. If the bit corresponding to a VLAN is set to 1, then the local system is enabled for sending and receiving frames on that VLAN; if the bit is set to 0, then the system is disabled from sending and receiving frames on that VLAN.
To avoid conflicts between overlapping partial updates by multiple managers (for example, updates which modify only a portion of an instance of this object, such as enable/disable a single VLAN on the trunk port), any SNMP Set operation accessing an instance of this object should also write the value of vlanTrunkPortSetSerialNo.
Syntax: OCTET STRING (SIZE (128)
Access: Read-write
vlanTrunkPortNativeVlan (vlanTrunkPortEntry 5)
Indicates the VlanIndex of the VLAN which is represented by native frames on this trunk port. For trunk ports not supporting the sending and receiving of native frames, this value should be set to zero.
Syntax: VlanIndex
Access: Read-write
vlanTrunkPortRowStatus (vlanTrunkPortEntry 5)
Indicates the status of this row. In some circumstances, the creation of a row in this table is needed to enable the appropriate trunking/tagging protocol on the port, to enable the use of VTP on the port, and to assign the port to the appropriate management domain. In other circumstances, rows in this table are created as a by-product of other operations.
Syntax: RowStatus
Access: Read-write
vlanTrunkPortInJoins (vlanTrunkPortEntry 7)
Indicates the number of VTP Join messages received on this trunk port.
Syntax: Counter32
Access: Read-only
vlanTrunkPortOutJoins (vlanTrunkPortEntry 8)
Indicates the number of VTP Join messages sent on this trunk port.
Syntax: Counter32
Access: Read-only
vlanTrunkPortOldAdverts (vlanTrunkPortEntry 9)
The number of VTP Advertisement messages which indicated the sender does not support VLAN-pruning received on this trunk port.
Syntax: Counter32
Access: Read-only
vlanTrunkPortVlansPruningEligible (vlanTrunkPortEntry 10)
A string of octets containing one bit per VLAN in the management domain on this trunk port. The first octet corresponds to VLANs with VlanIndex values of 0 through 7, the second octet to VLANs 8 through 15, and so forth. The most significant bit of each octet corresponds to the lowest value VlanIndex in that octet.
If the bit corresponding to a VLAN is set to 1, then the local system is permitted to prune that VLAN on this trunk port; if the bit is set to 0, then the system must not prune that VLAN on this trunk port.
vlanTrunkPortVlansPruningEligible (vlanTrunkPortEntry 10)--Continued
To avoid conflicts between overlapping partial updates by multiple managers, for example, updates which modify only a portion of an instance of this object (for example, enable/disable a single VLAN on the trunk port), any SNMP Set operation accessing an instance of this object should also write the value of vlanTrunkPortSetSerialNo.
Syntax: OCTET STRING (SIZE (128)
Access: Read-write
vlanTrunkPortVlansXmitJoined (vlanTrunkPortEntry 11)
A string of octets containing one bit per VLAN in the management domain on this trunk port. The first octet corresponds to VLANs with VlanIndex values of 0 through 7; the second octet to VLANs 8 through 15, and so forth. The most significant bit of each octet corresponds to the lowest value VlanIndex in that octet.
If the bit corresponding to a VLAN is set to 1, then this VLAN is presently being forwarded on this trunk port, for example, it is not pruned; if the bit is set to 0, then this VLAN is presently not being forwarded on this trunk port, either because it is pruned or for some other reason.
Syntax: OCTET STRING (SIZE (128)
Access: Read-only
vlanTrunkPortVlansRcvJoined (vlanTrunkPortEntry 12)
A string of octets containing one bit per VLAN in the management domain on this trunk port. The first octet corresponds to VLANs with VlanIndex values of 0 through 7, the second octet to VLANs 8 through 15, and so forth. The most significant bit of each octet corresponds to the lowest value VlanIndex in that octet.
vlanTrunkPortVlansRcvJoined (vlanTrunkPortEntry 12)--Continued
If the bit corresponding to a VLAN is set to 1, then the local switch is currently sending joins for this VLAN on this trunk port; for example, it is asking to receive frames for this VLAN. If the bit is set to 0, then the local switch is not currently sending joins for this VLAN on this trunk port.
Syntax: OCTET STRING (SIZE (128)
Access: Read-only
End of Table
vlanTrunkPortSetSerialNo (vlanTrunkPorts 2)
Provides an advisory lock to allow several cooperating SNMPv2 managers to coordinate their use of the SNMPv2 set operation acting upon any instance of vlanTrunkPortVlansEnabled.
Syntax: TestAndIncr
Access: Read-write
This section contains descriptions of the groups and variables used for the management of the Catalyst 5000 series switch CISCO-VLAN-MEMBERSHIP-MIB. The MIB provides information on VLAN Membership Policy Servers used by a device and VLAN membership assignments of nontrunk bridge ports of the device.
ciscoVlanMembershipMIBObjects (ciscoVlanMembershipMIB 1)
The (ISL) VLAN ID of a VLAN uniquely identifies a VLAN within a management domain. This object contains the following groups:
The Cisco VLAN Membership MIB group identifies a VLAN within a management domain of the Catalyst 5000 series switch products.
The VLAN Query Protocol (VQP) version supported on the device. VQP is the protocol used to query VMPS for VLAN membership assignments of dynamic VLAN ports. A VMPS provides VLAN membership policy assignments based on the content of the packets received on a port.
Syntax: Integer 32
Access: Read-only
The number of retries for VQP requests to a VMPS before using the next available VMPS.
Syntax: INTEGER (1..10)
Access: Read-write
vmVmpsReconfirmInterval (vmVmps 3)
The switch periodically reconfirms address membership on each port with VMPS. This object specifies the interval to perform reconfirmation. If the value is set to 0, the switch does not reconfirm membership with VMPS.
Syntax: INTEGER (0..120)
Access: Read-write
Setting this object to execute (2) causes the switch to reconfirm membership of every dynamic port. Reading this object always return ready (1).
Syntax: INTEGER {
Access: Read-write
vmVmpsReconfirmResult (vmVmps 5)
This object returns the result of the last request that sets vmVmpsReconfirm to reconfirm (2).
Syntax: INTEGER {
vmVmpsReconfirmResult (vmVmps 5)--Continued
Access: Read-only
This is the IpAddress of the current VMPS used.
Syntax: IpAddress
Access: Read-only
A table of VMPS to use. The device uses the the primary VMPS by default. If the device is unable to reach the primary server after vmVmpsRetries retries, it uses the first secondary server in the table until it runs out of secondary servers, in which case it returns to using the primary server. Entries in this table can be created and deleted via this MIB or the management console on a device.
Syntax: SEQUENCE OF VmVmpsEntry
Access: Not accessible
An entry (conceptual row) in the vmVmpsTable, which includes the following variables: vmVmpsIpAddress, vmVmps, vmVmpsRowStatus.
Syntax: VmVmpsEntry
Access: Not accessible
vmVmpsIpAddress (vmVmpsEntry 1)
The VMPS IP address.
Syntax: IpAddress
Access: Accessible-for-notify
The status of the VMPS. Setting this value to true makes this VMPS the primary server and makes the switch use this as the current server. Setting this entry to true causes other rows to transition to false. Attempting to write a value of false after creation results in a return of bad value. Deleting an entry whose value is true results in the first entry in the table being set to true.
Syntax: TruthValue
Access: Read-write
vmVmpsRowStatus (vmVmpsEntry 3)
The status of this conceptual row.
Syntax: RowStatus
Access: Read-write
End of Table
vmMembershipSummaryTable (vmMembership 1)
A summary of VLAN membership of nontrunk bridge ports, and includes the following variables: vmMembershipSummaryVlanIndex, vmMembershipSummaryMemberPorts. This is a convenience table for retrieving VLAN membership information. A row is created for a VLAN if one of the following occurs:
vmMembershipSummaryTable (vmMembership 1)--Continued
Syntax: SEQUENCE OF VmMembershipSummaryEntry
Access: Not accessible
vmMembershipSummaryEntry (vmMembershipSummaryTable 1)
An entry (conceptual row) in the vmMembershipSummaryTable.
Syntax: VmMembershipSummaryEntry
Access: Not accessible
vmMembershipSummaryVlanIndex (vmMembershipSummaryEntry 1)
The VLAN ID of the VLAN.
Syntax: VlanIndex
Access: Not accessible
vmMembershipSummaryMemberPorts (vmMembershipSummaryEntry 2)
The set of the device's member ports that belong to the VLAN.
Each octet within the value of this object specifies a set of eight ports, with the first octet specifying ports 1 through 8, the second octet specifying ports 9 through 16, and so forth. Within each octet, the most significant bit represents the lowest numbered port, and the least significant bit represents the highest numbered port. Thus, each port of the VLAN is represented by a single bit within the value of this object. If that bit has a value of 1 then that port is included in the set of ports; the port is not included if its bit has a value of 0.
A port number is the same as the bridge port number as defined in RFC 1493.
vmMembershipSummaryMemberPorts (vmMembershipSummaryEntry 2)--Continued
Syntax: OCTET STRING ( SIZE(0..128)
Access: Read-only
End of Table
vmMembershipTable (vmMembership 2)
A table for configuring VLAN port membership, which includes the following variables: vmVlanType, vmVlan, vmPortStatus. There is one row for each bridge port that is assigned to at most one VLAN. Ports with more than one VLAN are not represented. An entry can be created and deleted when ports are created or deleted via SNMP or the management console on a device.
Syntax: SEQUENCE OF VmMembershipEntry
Access: Not accessible
vmMembershipEntry (vmMembershipTable 1)
An entry (conceptual row) in the vmMembershipTable.
Syntax: VmMembershipEntry
Access: Not accessible
vmVlanType (vmMembershipEntry 1)
The type of VLAN membership assigned to this port. A port with static membership is assigned to a VLAN directly. A port with dynamic membership is assigned a VLAN based on content of packets received on the port and via VQP queries to VMPS.
Syntax: INTEGER {
Access: Read-write
The VLAN ID of the VLAN the port is assigned to, or 0 if the port is not assigned to a VLAN. If vmVlanType is static, the port is always assigned to a VLAN and the object can not be set to 0.
If vmVlanType is dynamic, the object's value is 0 if the port is currently not assigned to a VLAN. In addition, the object can be set to 0 only.
Syntax: INTEGER (0..1023)
Access: Read-write
vmPortStatus (vmMembershipEntry 3)
An indication of the current VLAN status of the port.
Syntax: INTEGER {
Access: Read-only
End of Table
The total number of VQP requests sent by this device to all VMPS since last system re-initialization.
Syntax: Counter32
Access: Read-only
vmVQPResponses (vmStatistics 2)
The number of VQP responses received by this device from all VMPS since last system re-initialization.
Syntax: Counter32
Access: Read-only
vmVmpsChanges (vmStatistics 3)
The number of times, since last system re-initialization, the current VMPS was changed. The current VMPS is changed whenever the VMPS fails to response after vmVmpsRetries of a VQP request.
Syntax: Counter32
Access: Read-only
vmVQPShutdown (vmStatistics 4)
The number of times, since last system re-initialization, a VQP response indicates "shutdown." A "shutdown" response is a result of the membership policy configured at a VMPS by the administrator.
Syntax: Counter32
Access: Read-only
The number of times, since last system re-initialization, a VQP response indicates denied. A denied response is a result of the membership policy configured at a VMPS by the administrator.
Syntax: Counter32
Access: Read-only
vmVQPWrongDomain (vmStatistics 6)
The number of times since last system re-initialization a VQP response indicates wrong management domain. A wrong management domain response indicates that the VMPS used serves a management domain that is different from the device's management domain.
Syntax: Counter32
Access: Read-only
vmVQPWrongVersion (vmStatistics 7)
The number of times, since last system re-initialization, a VQP response indicates wrong VQP version. A wrong VQP version response indicates that the VMPS used supports a VQP version that is different from the device's VQP version.
Syntax: Counter32
Access: Read-only
vmInsufficientResources (vmStatistics 8)
The number of times since last system re-initialization a VQP response indicates insufficient resources. An insufficient resources response indicates that the VMPS used does not have the required resources to verify the membership assignment requested.
Syntax: Counter32
Access: Read-only
A collection of objects for displaying and configuring VLAN membership. The following variables are used and can be found in previous sections: vmVlan (vmMembershipEntry 2), vmVlanType (vmMembershipEntry 1), vmPortStatus (vmMembershipEntry 3).
The vmVQPClientGroup group contains a collection of objects for the managing of a VQP client. A VQP client must implement this group. The following variables are used and can be found in previous sections:
|
|