Searching the Help
To search for information in the Help, type a word or phrase in the Search box. When you enter a group of words, OR is inferred. You can use Boolean operators to refine your search.
Results returned are case insensitive. However, results ranking takes case into account and assigns higher scores to case matches. Therefore, a search for "cats" followed by a search for "Cats" would return the same number of Help topics, but the order in which the topics are listed would be different.
Search for | Example | Results |
---|---|---|
A single word | cat
|
Topics that contain the word "cat". You will also find its grammatical variations, such as "cats". |
A phrase. You can specify that the search results contain a specific phrase. |
"cat food" (quotation marks) |
Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase. |
Search for | Operator | Example |
---|---|---|
Two or more words in the same topic |
|
|
Either word in a topic |
|
|
Topics that do not contain a specific word or phrase |
|
|
Topics that contain one string and do not contain another | ^ (caret) |
cat ^ mouse
|
A combination of search types | ( ) parentheses |
|
MIB Form
[This is the context-sensitive help link for the MIB form = alias = mibFormHelp
The MIB form provides details about the selected MIB file that is loaded on the NNMi management server. This topic includes the following sections:
- MIB Variable Tab
- MIB Variable Form
- MIB Variable Form: Enumerated Values Tab
- MIB Variable: Enumerated Values Form
- MIB Variable Form: Table Indices Tab
- MIB Notifications Tab
- MIB Notification Form
- MIB Notification Form: Notification Variables Tab
- Notification Variable Form
- MIB Notification Basic Attributes
- Textual Conventions Basic Attributes
- Textual Conventions Tab
- Textual Convention Form
- Textual Convention Form: Enumerated Values Tab
- Textual Convention: Enumerated Values Form
For information about each tab: See Also
To view the MIB Form:
Level-2 Operators and above, do one of the following:
-
Method one, in any map or Node table view:
-
Click or right-click a Node:
- Click and select Actions → MIB Information → List Supported MIBs.
- Right-click and select MIB Information → List Supported MIBs.
- Click the link to the MIB file of interest.
-
-
Method two, in the Inventory workspace, MIB Variables view:
- Double-click a row to open a MIB Variable form.
- Navigate to the MIB attribute, click the drop-down, and select Open.
-
Method three, alternate path for NNMi administrators:
- Open the Configuration workspace, MIBs folder.
- Open the Loaded MIBs view.
- Double-click the row of interest.
Attribute | Description |
---|---|
Name | Name from the DEFINITIONS clause within the MIB file. |
MIB File | Location of the MIB file on the NNMi server. |
MIB Variable Tab
[This is the context-sensitive help for the MIB Variable form.]
The MIB form's MIB Variables tab lists all MIB variables available within the currently displayed MIB file.
To view a list of all MIB Variables from all MIB files:
- Level-2 Operators and above can use the Inventory workspace, MIB Variables view.
- NNMi administrators can use the Configuration workspace, MIBs folder, MIB Variables view.
For information about each tab:See Also
Attribute | Description | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
OID (Numeric) |
The numeric representation of the OID (Object Identification) value for the selected MIB variable. For example, |
||||||||||||||||||||||||||||||||
Name |
The Name value that is stored in the MIB definition for the selected MIB variable. For example, |
||||||||||||||||||||||||||||||||
Syntax |
The SYTNAX value for the MIB variable. Valid values for MIB variable that can be included in a MIB Expression include the following:
For example, the ifAdminStatus OBJECT-TYPE For more information, click here.
|
||||||||||||||||||||||||||||||||
OID (Text) |
The textual representation of the OID for the selected MIB variable. For example, the Double-click the row representing a MIB variable. The MIB Variable Form displays all details about the selected MIB variable. |
[This is the context-sensitive help for the MIB Variable form.]
The MIB Variable form enables you to view more detailed information about the selected MIB variable provided by a MIB file loaded on the NNMi management server.
For example, the IF-MIB's ifAdminStatus
:
ifAdminStatus OBJECT-TYPE
SYNTAX INTEGER {
up(1), -- ready to pass packets
down(2),
testing(3) -- in some test mode
}
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The desired state of the interface. The testing(3) state
indicates that no operational packets can be passed."
::= { ifEntry 7 }
For information about each tab: See Also
To view the MIB Variable form:
-
Level-2 Operators and above, do one of the following:
Method one, from the Inventory workspace:
- Navigate to the Inventory workspace, MIB Variables view:
- Click the row containing the MIB variable of interest.
Method two, using Actions:
-
In any map or Node table view, do one of the following:
- Click a Node and select Actions → MIB Information → List Supported MIBs.
- Right-click a Node and select MIB Information → List Supported MIBs.
- Click the link to the MIB file of interest.
- Navigate to the MIB Variables tab.
- Select the OID (Numeric) of interest to open an MIB Variable form.
Method three, for NNMi administrators using the Configuration workspace:
-
To view information about one MIB file, open the Configuration workspace, MIBs folder, Loaded MIBs view.
- Double-click the row of interest.
- Navigate to the MIB Variables tab.
- Select the OID (Numeric) of interest to open an MIB Variable form.
-
To view information from all MIB files combined, open the Configuration workspace, MIBs folder, MIB Variables view.
Select the OID (Numeric) of interest to open an MIB Variable form.
- (Optional) To gather this information from a node, see Run SNMP Walk Commands (MIB Browser).
Attribute | Description |
---|---|
Name |
The Name value that is stored in the MIB definition for the selected MIB variable. For example |
OID (Numeric) |
The numeric representation of the OID (Object Identification) value for the selected MIB variable. For example: |
OID (Text) |
A symbolic OID uses mnemonic keywords to specify the managed object. For example: . |
Syntax |
The SYTNAX value for the MIB variable. For example, the ifAdminStatus OBJECT-TYPE For more information, click here.
|
Textual Convention | Defines the format rules to be used when displaying the MIB value. See Textual Convention Form for more information. |
MIB |
The name value that is stored at the beginning of the MIB definitions to identify the MIB. For example,
|
Description |
The Description that is stored in the MIB for the selected MIB variable. For example, the
|
The Enumerated Values tab enables you to view each enumerated value pair, if any, for a selected MIB OID. For example, the IF-MIB's ifAdminStatus
includes three enumerated values for status 1=up, 2=down, 3=testing, as shown in the following example:
ifAdminStatus OBJECT-TYPE
SYNTAX INTEGER {
1 up,
2 down),
3 testing
}
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The desired state of the interface. The testing(3) state
indicates that no operational packets can be passed."
::= { ifEntry 7 }
For information about each tab: See Also
Attribute | Description |
---|---|
String Value | The text value that is associated with the Numeric Value for the selected MIB variable. |
Numeric Value |
The numeric value that is associated with the String Value for the selected MIB variable. Double-click the row representing an enumerated value pair. The MIB Variable: Enumerated Values Form displays all details about the selected enumerated value pair. |
MIB Variable: Enumerated Values Form
[This is the context-sensitive help for the MIB Variable: Enumerated Values form = alias = mibEnumeratedValueFormHelp.]
The Enumerated Values form edisplays the details of an enumerated value pair, if any, for a selected MIB variable. For example, the IF-MIB's ifAdminStatus
, includes enumerated values for status as shown in the following example:
ifAdminStatus OBJECT-TYPE
SYNTAX INTEGER {
1 up,
2 down),
3 testing
}
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The desired state of the interface. The testing(3) state
indicates that no operational packets can be passed."
::= { ifEntry 7 }
To view the Enumerated Value form:
-
Level-2 Operators and above, do one of the following:
Method one, from the Inventory workspace:
- Navigate to the Inventory workspace, MIB Variables view:
- Click the row containing the MIB variable of interest.
Method two, using Actions:
-
In any map or Node table view, do one of the following:
- Click a Node and select Actions → MIB Information → List Supported MIBs.
- Right-click a Node and select MIB Information → List Supported MIBs.
- Click the link to the MIB file of interest.
- Navigate to the MIB Variables tab.
- Select the OID (Numeric) of interest to open an MIB Variable form.
Method three, for NNMi administrators using the Configuration workspace:
-
To view information about one MIB file, open the Configuration workspace, MIBs folder, Loaded MIBs view.
- Double-click the row of interest.
- Navigate to the MIB Variables tab.
- Select the OID (Numeric) of interest to open an MIB Variable form.
-
To view information from all MIB files combined, open the Configuration workspace, MIBs folder, MIB Variables view.
Select the OID (Numeric) of interest to open an MIB Variable form.
-
Navigate to the Enumerated Values tab.
This table displays the string and numeric value for each enumeration, if any, specified for the selected MIB variable.
- Select the String Value of interest to open the Enumerated Values form.
The Table Indices tab enables you to view the index values, if any, for a selected MIB variable. Table indices are used to store multiple values for a single MIB variable.
In the example, atIfIndex
and atNetAddress
are table indices for the RFC1213-MIB's atEntry
variable. Table indices are identified using the INDEX keyword:
atEntry OBJECT-TYPE
SYNTAX AtEntry
ACCESS not-accessible
STATUS deprecated
DESCRIPTION
"Each entry contains one NetworkAddress to
`physical' address equivalence."
INDEX { atIfIndex,
atNetAddress }
::= { atTable 1 }
For information about each tab: See Also
Attribute | Description |
---|---|
Position |
The position number of the MIB variable that is used as a Table Index object. For example, Table Index object positions for
|
Name |
The name of the selected MIB variable that is used as a Table Index object. Table indices are used for storing multiple values for a MIB variable. Double-click the row representing a Table Index. The Table Index Form displays all details about the selected Table Index. |
Table Index Form
[This is the context-sensitive help for the MIB Variable: Table Index form = alias = mibTableIndexFormHelp.]
The Table Index form defines one of the multiple-choice values allowed within a single MIB variable.
In the example, atIfIndex
and atNetAddress
are table indices for the RFC1213-MIB's atEntry
variable. Table indices are identified using the INDEX keyword:
atEntry OBJECT-TYPE
SYNTAX AtEntry
ACCESS not-accessible
STATUS deprecated
DESCRIPTION
"Each entry contains one NetworkAddress to
`physical' address equivalence."
INDEX { atIfIndex,
atNetAddress }
::= { atTable 1 }
To view the Table Index form:
-
Level-2 Operators and above, do one of the following:
Method one, from the Inventory workspace:
- Navigate to the Inventory workspace, MIB Variables view:
- Click the row containing the MIB variable of interest.
Method two, using Actions:
-
In any map or Node table view, do one of the following:
- Click a Node and select Actions → MIB Information → List Supported MIBs.
- Right-click a Node and select MIB Information → List Supported MIBs.
- Click the link to the MIB file of interest.
- Navigate to the MIB Variables tab.
- Select the OID (Numeric) of interest to open an MIB Variable form.
Method three, for NNMi administrators using the Configuration workspace:
-
To view information about one MIB file, open the Configuration workspace, MIBs folder, Loaded MIBs view.
- Double-click the row of interest.
- Navigate to the MIB Variables tab.
- Select the OID (Numeric) of interest to open an MIB Variable form.
-
To view information from all MIB files combined, open the Configuration workspace, MIBs folder, MIB Variables view.
Select the OID (Numeric) of interest to open an MIB Variable form.
-
Navigate to the Table Indices tab.
This table displays the position and name value for each index entry, if any, specified for the selected MIB Variable.
- Select the Position of interest to open the Table Index form.
MIB Notifications Tab
[This is the context-sensitive help for the Loaded MIBs: MIB Notifications form = alias = mibNotificationFormHelp.]
The MIB form's MIB Notifications tab lists each SNMP trap enabled by the currently displayed MIB file.
To view a list of all MIB Notifications from all MIB files, NNMi administrators can use the Configuration workspace, MIBs folder, MIB Notifications view.
For information about each tab: See Also
Attribute | Description |
---|---|
OID (Numeric) |
The numeric representation of the OID (Object Identification) value for the selected MIB notification. For example: |
Name |
The Name value that is stored in the MIB definition for the selected MIB notification. For example: |
OID (Text) |
The textual representation of the OID for the selected MIB variable. For example: Double-click the row representing a notification. The MIB Notification Form displays all details about the selected notification. |
[This is the context-sensitive help for the Loaded MIBs: MIB Notifications form = alias = mibNotificationFormHelp.]
The MIB Notification form enables you to view the SNMP trap information, if any, that is defined by the selected MIB. For example, the IF-MIB's linkDown
, includes notification values as shown in the following example:
linkDown NOTIFICATION-TYPE
OBJECTS { ifIndex, ifAdminStatus, ifOperStatus }
STATUS current
DESCRIPTION
"A linkDown trap signifies that the SNMP entity, acting in
an agent role, has detected that the ifOperStatus object for
one of its communication links is about to enter the down
state from some other state (but not from the notPresent
state). This other state is indicated by the included value
of ifOperStatus."
::= { snmpTraps 3 }
For information about each tab See Also
To view the MIB Notification form:
-
Level-2 Operators and above, do one of the following:
Method one, using Actions:
-
In any map or Node table view, do one of the following:
- Click a Node and select Actions → MIB Information → List Supported MIBs.
- Right-click a Node and select MIB Information → List Supported MIBs.
- Click the link to the MIB file of interest.
- Navigate to the MIB Notifications tab.
- Select the OID (Numeric) of interest to open an MIB Notifications form.
Navigate to the MIB Variables tab.
Method two, for NNMi administrators using the Configuration workspace:
- Open the Configuration workspace, MIBs folder.
- Open the Loaded MIBs view.
- Double-click the row of interest.
- Navigate to the MIB Notifications tab.
- Select the OID (Numeric) of interest to open an MIB Notifications form.
-
- (Optional) To gather this information from a node, see Run SNMP Walk Commands (MIB Browser).
The MIB Notification form's Notification Variables tab enables you to view the SNMP trap information, if any, that can be sent by the selected MIB. In the following example, the IF-MIB's linkDown
OID provides an SNMP trap. When this trap is generated, the ifIindex
, ifAdminStatus
, and ifOperStatus
values are included in the SNMP trap text:
linkDown NOTIFICATION-TYPE
OBJECTS { ifIndex, ifAdminStatus, ifOperStatus }
STATUS current
DESCRIPTION
"A linkDown trap signifies that the SNMP entity, acting in
an agent role, has detected that the ifOperStatus object for
one of its communication links is about to enter the down
state from some other state (but not from the notPresent
state). This other state is indicated by the included value
of ifOperStatus."
::= { snmpTraps 3 }
For information about each tab: See Also
Attribute | Description |
---|---|
Position |
The position number of the MIB variable in the Notification Variable object's definition. In the following example,
|
Name |
The name of the MIB variable. In the following example
Double-click the row representing a Table Index. The Notification Variable Form displays all details about the selected Table Index. |
[This is the context-sensitive help for the MIB Variable: Notification Variable form = alias = .mibNotificationVariableFormHelp.]
The Notification Variables form displays the information that will be included when the SNMP trap is generated. In the following example, the IF-MIB's linkDown
OID provides an SNMP trap. When this trap is generated, the ifIindex
, ifAdminStatus
, and ifOperStatus
values are included in the SNMP trap text:
linkDown NOTIFICATION-TYPE
OBJECTS { ifIndex, ifAdminStatus, ifOperStatus }
STATUS current
DESCRIPTION
"A linkDown trap signifies that the SNMP entity, acting in
an agent role, has detected that the ifOperStatus object for
one of its communication links is about to enter the down
state from some other state (but not from the notPresent
state). This other state is indicated by the included value
of ifOperStatus."
::= { snmpTraps 3 }
To view the Notification Variable form:
-
Level-2 Operators and above, do one of the following:
-
Method one, in any map or Node table view:
-
Click or right-click a Node:
- Click and select Actions → MIB Information → List Supported MIBs.
- Right-click and select MIB Information → List Supported MIBs.
- Click the link to the MIB file of interest.
-
-
Method two, in the Inventory workspace, MIB Variables view:
- Double-click a row to open a MIB Variable form.
- Navigate to the MIB attribute, click the drop-down, and select Open.
-
Method three, alternate path for NNMi administrators:
- Open the Configuration workspace, MIBs folder.
- Open the Loaded MIBs view.
- Double-click the row of interest.
-
- Navigate to the MIB Notifications tab.
- Select the OID (Numeric) of interest to open an MIB Notification form.
-
Navigate to the Notification Variables tab.
This table displays the string and numeric value for each notification, if any, specified for the selected MIB Notification.
- Select the Position of interest to open the Notification Variable form.
Textual Conventions Tab
The MIB form's MIB Textual Conventions tab lists all the format rules defined in the currently displayed MIB file. NNMi uses these MIB format rules to determine how to display any associated MIB variable values.
To view a list of all Textual Conventions from all MIB files, NNMi administrators can use the Configuration workspace, MIBs folder, Textual Conventions view.
For information about each tab: See Also
Attribute | Description |
---|---|
Name |
The Name value that is stored in the MIB definition for the selected textual convention. For example: |
Display Hint |
Format rule used with the Value Constraint and Primitive Type to help determine the format when displaying the associated MIB value. For example: for |
Primitive Type |
Defines the base type to be used when determining the format for displaying the associated MIB variable value. For example: for the |
Value Constraint |
Format rule used with the Display Hint and Primitive Type to help determine the format when displaying the associated MIB variable value. For example: for the Double-click the row representing an enumerated value pair. The Textual Convention Form displays all details about the selected enumerated value pair. |
[This is the context-sensitive help for the Textual Conventions form = alias = mibTextualConventionFormHelp.]
The MIB Textual Convention form displays format rules for the selected Textual Convention value. MIB files define any required Textual Conventions for their MIB Variables and MIB Notifications. NNMi uses these MIB format rules for determining how to display any associated MIB values.
For information about each tab: See Also
To view the MIB's Textual Convention form:
Level-2 Operators and above, do one of the following:
-
In any map or Node table view, do one of the following:
- Click a Node and select Actions → MIB Information → List Supported MIBs.
- Right-click a Node and select MIB Information → List Supported MIBs.
- Click the link to the MIB file of interest.
- Navigate to the Textual Conventions tab.
- Select the Name of interest to open an MIB Textual Convention form.
-
To view information about one MIB file, open the Configuration workspace, MIBs folder, Loaded MIBs view.
- Double-click the row of interest.
- Navigate to the Textual Conventions tab.
- Select the Name of interest to open an MIB Textual Convention form.
-
To view information from all MIB files combined, open the Configuration workspace, MIBs folder, Textual Conventions view.
Select the Name of interest to open a MIB Textual Convention form.
Attribute | Description |
---|---|
Name | The Name value that is stored in the MIB file's definition for the selected textual convention. |
Status |
The Status value that is stored in the MIB file's definition for the selected textual convention. Possible values are:
|
Display Hint | Format rule used with the Value Constraint and Primitive Type to help determine the format when displaying the associated MIB value. For example, to display the MAC Address, the DISPLAY-HINT is "1x:" to indicate the value must consist of a one-byte hex string or two-hex digits, such as 01 or AB . |
Value Constraint | Format rule used with the Display Hint and Primitive Type to help determine the format when displaying the associated MIB variable value. For example, the value constraint under SYNTAX for the MAC Address is (SIZE (6)) to indicate the format must include six one-byte hex strings, such as 0A:BC:1D:2E:3F:40 . |
Primitive Type |
Defines the base type to be used when determining the format for displaying the associated MIB variable value. For example, |
MIB |
The name value that is stored at the beginning of the MIB File to identify the MIB. See Display a MIB File (source text file). To explore all of the information available from this MIB, click the Lookup icon, and select Open to open the MIB Form. |
Description | The Description that is stored in the MIB for the selected Textual Convention. |
The Enumerated Values tab enables you to view each enumerated value pair, if any, for a selected MIB OID. For example, the IF-MIB's ifAdminStatus
includes three enumerated values for status 1=up, 2=down, 3=testing, as shown in the following example:
ifAdminStatus OBJECT-TYPE
SYNTAX INTEGER {
1 up,
2 down),
3 testing
}
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The desired state of the interface. The testing(3) state
indicates that no operational packets can be passed."
::= { ifEntry 7 }
For information about each tab: See Also
Attribute | Description |
---|---|
String Value | The text value that is associated with the Numeric Value for the selected MIB variable. |
Numeric Value |
The numeric value that is associated with the String Value for the selected MIB variable. Double-click the row representing an enumerated value pair. The Textual Convention: Enumerated Values Form displays all details about the selected enumerated value pair. |
Textual Convention: Enumerated Values Form
[This is the context-sensitive help for the MIB Variable: Enumerated Values form = alias = mibEnumeratedValueFormHelp.]
The Enumerated Values form displays the details of an enumerated value pair, if any, for a selected MIB variable. For example, the IF-MIB's ifAdminStatus
variable includes enumerated values for three statuses, as shown in the following example from the MIB file's source text file:
ifAdminStatus OBJECT-TYPE
SYNTAX INTEGER {
1 up,
2 down),
3 testing
}
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The desired state of the interface. The testing(3) state
indicates that no operational packets can be passed."
::= { ifEntry 7 }
To view the Enumerated Value form:
-
Level-2 Operators and above, do one of the following:
Method one, using Actions:-
In any map or Node table view, do one of the following:
- Click a Node and select Actions → MIB Information → List Supported MIBs.
- Right-click a Node and select MIB Information → List Supported MIBs.
- Click the link to the MIB file of interest.
- Navigate to the Textual Conventions tab.
- Select the Name of interest to open an MIB Textual Convention form.
Method two, for NNMi administrators:-
To view information about one MIB file, open the Configuration workspace, MIBs folder, Loaded MIBs view.
- Double-click the row of interest.
- Navigate to the Textual Conventions tab.
- Select the Name of interest to open an MIB Textual Convention form.
-
To view information from all MIB files combined, open the Configuration workspace, MIBs folder, Textual Conventions view.
Select the Name of interest to open a MIB Textual Convention form.
-
-
Navigate to the Enumerated Values tab.
This table displays the string and numeric value for each enumeration, if any, specified for the selected MIB variable.
- Select the String Value of interest to open the Enumerated Values form.
We welcome your comments!
To open the configured email client on this computer, open an email window.
Otherwise, copy the information below to a web mail client, and send this email to network-management-doc-feedback@hpe.com.
Help Topic ID:
Product:
Topic Title:
Feedback: