VIRTUAL-ROUTER-MIB
File:
VIRTUAL-ROUTER-MIB.mib (44962 bytes)
Imported modules
Imported symbols
Defined Types
VrIdentifier |
|
Virtual Router Identifier.
VRID 0 is reserved for the Administrative VR
and cannot be used to create VR's.
|
TEXTUAL-CONVENTION |
|
|
|
|
Unsigned32 |
0..4294967295 |
|
VrRpTriggerBitCode |
|
This object represents Routing Protocol (RP)
Triggers on a Virtual Router. The BITS
represent an Action-code that specifies the
action on the Routing Protocols.
The actions are: initiate or shutdown.
When encoding the RP using the BITS construct,
the value is encoded as an OCTET STRING where
the first bit (bit 0) is the highest bit of the
octet.
Bits 0-3 may be specified in any combination to
allow multiple Routing Protocols to be acted on
simultaneously or individually.
|
TEXTUAL-CONVENTION |
|
|
|
|
BITS |
rip(0), ospf(1), bgp(2), isis(3) |
|
VrConfigEntry |
|
SEQUENCE |
|
|
|
|
vrId |
VrIdentifier |
|
|
vrRowStatus |
RowStatus |
|
|
vrName |
DisplayString |
|
|
vrContextName |
DisplayString |
|
|
vrTrapEnable |
TruthValue |
|
|
vrMaxRoutes |
Unsigned32 |
|
|
vrAdminStatus |
INTEGER |
|
|
vrVpnId |
VPNId |
|
|
vrRpTrigger |
VrRpTriggerBitCode |
|
|
vrMaxRoutesTrapEnable |
TruthValue |
|
VrStatEntry |
|
SEQUENCE |
|
|
|
|
vrStatRouteEntries |
Unsigned32 |
|
|
vrStatFIBEntries |
Unsigned32 |
|
|
vrStatUpTime |
TimeTicks |
|
|
vrOperStatus |
INTEGER |
|
|
vrRpStatus |
VrRpTriggerBitCode |
|
|
vrRouterAddressType |
InetAddressType |
|
|
vrRouterAddress |
InetAddress |
|
VrIfConfigEntry |
|
SEQUENCE |
|
|
|
|
vrIfId |
InterfaceIndex |
|
|
vrIfConfigRowStatus |
RowStatus |
|
Defined Values
virtualRouterMIB |
1.3.6.1.2.1.1 |
The MIB module is the definition of the managed
objects for the Virtual Router. |
MODULE-IDENTITY |
|
|
|
vrConfig |
1.3.6.1.2.1.1.1.1 |
OBJECT IDENTIFIER |
|
|
|
vrConfigNextAvailableVrId |
1.3.6.1.2.1.1.1.1.1.1 |
The next available Virtual Router Id (index).
This object provides a hint for the vrID value
to use when administratively creating a new
vrConfigEntry.
A GET of this object returns the next available vrId
value to be used to create an entry in the associated
vrConfigTable; or zero, if no valid vrId
value is available. A value of zero(0) indicates that
it is not possible to create a new vrConfigEntry
This object also returns a value of zero when it is the
lexicographic successor of a varbind presented in an
SNMP GETNEXT or GETBULK request, for which circumstance
it is assumed that ifIndex allocation is unintended.
Successive GETs will typically return different
values, thus avoiding collisions among cooperating
management clients seeking to create table entries
simultaneously.
Unless specified otherwise by its MAX-ACCESS and
DESCRIPTION clauses, an object of this type is read-only,
and a SET of such an object returns a notWritable error. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
VrIdentifier |
|
|
vrConfigTable |
1.3.6.1.2.1.1.1.1.2 |
This table is for creating the new Virtual Routers. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
SEQUENCE OF |
|
|
|
|
VrConfigEntry |
|
vrConfigEntry |
1.3.6.1.2.1.1.1.1.2.1 |
The entries in this table can be added/deleted
using the vrRowStatus. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
VrConfigEntry |
|
|
vrId |
1.3.6.1.2.1.1.1.1.2.1.1 |
The unique id of this virtual router instance. A Virtual
Router cannot not be created with vrId = 0.
VRID 0 is reserved for the Administrative VR.
|
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
VrIdentifier |
|
|
vrRowStatus |
1.3.6.1.2.1.1.1.1.2.1.2 |
The status column has three defined values:
- `active', which indicates that the conceptual row is
available for use by the managed device;
- `createAndGo', which is supplied by a management
station wishing to create a new instance of a
conceptual row and to have its status automatically set
to active, making it available for use by the managed
device;
- `destroy', which is supplied by a management station
wishing to delete all of the instances associated with
an existing conceptual row. |
Status: current |
Access: read-create |
OBJECT-TYPE |
|
|
|
|
RowStatus |
|
|
vrName |
1.3.6.1.2.1.1.1.1.2.1.3 |
The Name of the Virtual Router. |
Status: current |
Access: read-create |
OBJECT-TYPE |
|
|
|
|
DisplayString |
|
|
vrContextName |
1.3.6.1.2.1.1.1.1.2.1.4 |
The SNMPv2 Community String or SNMPv3 contextName
denotes the VR 'context' and is used to logically
separate the MIB module management. |
Status: current |
Access: read-create |
OBJECT-TYPE |
|
|
|
|
DisplayString |
|
|
vrTrapEnable |
1.3.6.1.2.1.1.1.1.2.1.5 |
This objects is used to enable the generation
of the VrUp and VrDown traps.
true(1) - VR Traps Enabled
false(2) - VR Traps Disabled |
Status: current |
Access: read-create |
OBJECT-TYPE |
|
|
|
|
TruthValue |
|
|
vrMaxRoutes |
1.3.6.1.2.1.1.1.1.2.1.6 |
This object specifies the maximum number of routes that
this VR can support. The default value is 4 Gig (meaning
unlimited). |
Status: current |
Access: read-create |
OBJECT-TYPE |
|
|
|
|
Unsigned32 |
|
|
vrAdminStatus |
1.3.6.1.2.1.1.1.1.2.1.7 |
The administrative state of the Virtual Router. |
Status: current |
Access: read-create |
OBJECT-TYPE |
|
|
|
|
INTEGER |
up(1), down(2), testing(3), unknown(4) |
|
vrVpnId |
1.3.6.1.2.1.1.1.1.2.1.8 |
The Virtual Private Network Identifier of the Virtual
Router. |
Status: current |
Access: read-create |
OBJECT-TYPE |
|
|
|
|
VPNId |
|
|
vrRpTrigger |
1.3.6.1.2.1.1.1.1.2.1.9 |
This object represents Routing Protocol (RP)
Triggers on a Virtual Router and it meant to
be used to initiate or shutdown routing
protocols on a VR. Multiple RPs can be acted
on simultaneously. Also, individual RPs can
be brought up in steps, which should not
affect the RPs that were running. The BITS
represent an Action-code that specifies what
action is to be performed for the RPs.
The actions are: initiate(1) or shutdown(0).
The running status of an RP shall be available
in the VR stats table's vrRpStatus, which has
a similar format, but represents the status.
Bits 0-3 may be specified in any combination.
Individual routing protocols may be enabled
and disabled independently. Protocols are
enabled by setting the respective BIT and are
disabled by resetting the BIT.
So, for example, to enable RIP and BGP protocols
the vrRpTrigger bits 0 and 2 need to be set, and
as encoded as 10100000.
All zeros should be interpreted as all protocols
disable.
|
Status: current |
Access: read-create |
OBJECT-TYPE |
|
|
|
|
VrRpTriggerBitCode |
|
|
vrMaxRoutesTrapEnable |
1.3.6.1.2.1.1.1.1.2.1.10 |
This objects is used to enable the generation
of the VR Max Routes Exceeded traps.
true(1) - VR Max Routes Exceeded Traps Enabled
false(2) - VR Max Routes Exceeded Traps Disabled |
Status: current |
Access: read-create |
OBJECT-TYPE |
|
|
|
|
TruthValue |
|
|
vrStat |
1.3.6.1.2.1.1.1.2 |
OBJECT IDENTIFIER |
|
|
|
vrActiveVRs |
1.3.6.1.2.1.1.1.2.1.2 |
The number of VRs that are active on the network element.
These are VRs for which the
vrStatOperStatus = up(1) |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
Unsigned32 |
|
|
vrStatTable |
1.3.6.1.2.1.1.1.2.2 |
This table contains statistics for the Virtual Router. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
SEQUENCE OF |
|
|
|
|
VrStatEntry |
|
vrStatEntry |
1.3.6.1.2.1.1.1.2.2.1 |
Entries in this table a per vrId. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
VrStatEntry |
|
|
vrStatFIBEntries |
1.3.6.1.2.1.1.1.2.2.1.2 |
Total number of FIB Entries for this VR. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
Unsigned32 |
|
|
vrStatUpTime |
1.3.6.1.2.1.1.1.2.2.1.3 |
The time in (in hundredths of a second) since
this VR entry has been operational. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
TimeTicks |
|
|
vrOperStatus |
1.3.6.1.2.1.1.1.2.2.1.4 |
The operational status of the Virtual Router. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
INTEGER |
up(1), down(2), unknown(3) |
|
vrRpStatus |
1.3.6.1.2.1.1.1.2.2.1.5 |
This object represents the status of Routing
Protocols on this VR corresponding to the list
of RP specified in vrRpTrigger.
The BITS represent an Action-code that specifies
the status of the RPs.
The status are: initiated (1) or shutdown (0).
Initiated status is indicated when the respective
BIT value is 1 and indicates shutdown when the
respective BIT value is 0.
Bits 0-3 may appear in any combination to
indicate that RPs may be enabled and disabled
independently or that multiple RP are acted on
simultaneously.
|
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
VrRpTriggerBitCode |
|
|
vrRouterAddress |
1.3.6.1.2.1.1.1.2.2.1.7 |
Router Address of this VR. It is derived from one of the
interfaces. If loopback interface is present, the loopback
interface address can be used. However, loopback interface
is optional. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
InetAddress |
|
|
vrIfConfigTable |
1.3.6.1.2.1.1.1.3.2 |
This table is for configuring VR Interfaces. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
SEQUENCE OF |
|
|
|
|
VrIfConfigEntry |
|
vrIfConfigEntry |
1.3.6.1.2.1.1.1.3.2.1 |
Entries in this table correspond to the entries in
the ifTable that apply to the Virtual Router. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
VrIfConfigEntry |
|
|
vrIfId |
1.3.6.1.2.1.1.1.3.2.1.1 |
Virtual Router Interface Index. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
InterfaceIndex |
|
|
vrIfConfigRowStatus |
1.3.6.1.2.1.1.1.3.2.1.2 |
This object is used to create, delete or
modify a row in this table. |
Status: current |
Access: read-create |
OBJECT-TYPE |
|
|
|
|
RowStatus |
|
|
vrUp |
1.3.6.1.2.1.1.1.4.0.1 |
This notification is generated when the specified
VR is about to be initialized or change the VR's
operational status from down to up. |
Status: current |
Access: read-create |
NOTIFICATION-TYPE |
|
|
|
vrDown |
1.3.6.1.2.1.1.1.4.0.2 |
This notification is generated when the specified
VR's operational status is about to go down. |
Status: current |
Access: read-create |
NOTIFICATION-TYPE |
|
|
|
vrMaxRoutesExceeded |
1.3.6.1.2.1.1.1.4.0.3 |
This notification is generated when the specified VR has
exceeded the maximum number of routes specified.
|
Status: current |
Access: read-create |
NOTIFICATION-TYPE |
|
|
|
vrMIBCompliance |
1.3.6.1.2.1.1.2.1.1 |
The compliance statement for entities that implement the
VIRTUAL-ROUTER-MIB. Implementation of this MIB module
is strongly recommended for any platform targeted for a
carrier-class environment.
When this MIB module is implemented with support for
read-create, then such an implementation can claim full
compliance.
Such devices can then be both monitored and configured
with this MIB. |
Status: current |
Access: read-create |
MODULE-COMPLIANCE |
|
|
|
vrGroups |
1.3.6.1.2.1.1.2.2 |
OBJECT IDENTIFIER |
|
|
|
vrConfigGroup |
1.3.6.1.2.1.1.2.2.1 |
A collection of attributes that support provisioning
of a virtual router. |
Status: current |
Access: read-create |
OBJECT-GROUP |
|
|
|
vrStatGroup |
1.3.6.1.2.1.1.2.2.2 |
A collection of attributes that contain stats about the
virtual router. |
Status: current |
Access: read-create |
OBJECT-GROUP |
|
|
|
vrIfGroup |
1.3.6.1.2.1.1.2.2.3 |
A collection of attributes that support provisioning of
a virtual router interfaces. |
Status: current |
Access: read-create |
OBJECT-GROUP |
|
|
|
vrNotificationGroup |
1.3.6.1.2.1.1.2.2.4 |
A collection of traps that are supported by the VR. |
Status: current |
Access: read-create |
NOTIFICATION-GROUP |
|
|
|