C H A P T E R 5

Monitor Component Information and Manage Inventory Using SNMP

Topics |
--- | ---
Description | Links
Review the prerequisites | Before You Begin
View component information and manage inventory | View Component Information View and Set Clock Settings View and Clear the ILOM Event Log Configure Remote Syslog Receiver IP Addresses
Manage alert rules | Configure an Alert Rule
Configure SMTP client for Email notification alerts | Configure SMTP Client for Email Notification Alerts
Configure alerts | View and Configure Email Alert Settings
Configure Telemetry Harness Daemon | View and Configure Telemetry Harness Daemon Settings

Related Topics |  |
--- | --- | ---
For ILOM | Section | Guide
Concepts | System Monitoring and Alert Management | Oracle Integrated Lights Out Manager (ILOM) 3.0 Concepts Guide (820-6410)
CLI | Managing Alerts | Oracle Integrated Lights Out Manager (ILOM) 3.0 CLI Procedures Guide (820-6412)
Web | Managing Alerts | Oracle Integrated Lights Out Manager (ILOM) 3.0 Web Interface Procedures Guide (820-6411)
The ILOM 3.0 Documentation Collection is available at: `http://docs.sun.com/app/docs/prod/int.lights.mgr30#hic`

##

Before You Begin

- Before you can use SNMP to view and configure ILOM settings, you must configure SNMP. For more information, see Preparing Your System to Use SNMP.

- When executing the `snmpset` command, you need to use a v1/v2c community or a v3 user with read/write (rw) privileges.

- For examples of SNMP commands, see SNMP Command Examples.

Note - The example SNMP commands presented in this section are based on the Net-SNMP sample applications and, therefore, will only work as presented if you have Net-SNMP and the Net-SNMP sample applications installed.

##

Viewing Component Information

Topics |
--- | ---
Description | Links
View the component information | View Component Information Component MIB Objects

Component Information

### View Component Information

Note - You can use `get` commands to view component information. For a description of the MIB objects used in this procedure, see Component MIB Objects.

1. Log in to a host that has an SNMP tool and the ILOM MIBs installed. For example, type:

`ssh` username`@`snmp_manager_ip_address

`Password``:` password

2. To view the firmware revision, type:

    % snmpget -v2c -cprivate -mALL SNMP_agent_ip_address entPhysicalFirmwareRev.1

#### Component MIB Objects

TABLE 5-1 lists several of the MIB objects provided by the ENTITY-MIB that you can use to view components.

TABLE 5-1 MIB Objects, Values, and Types for Component Settings
MIB Object | Description | Values | Type | Default
--- | --- | --- | --- | ---
`entPhysical` `Name` | The textual name of the physical entity. | Size: 0..255 | String | Zero-length string
`entPhysical` `Descr` | A textual description of physical entity. | Size: 0..255 | String | None
`entPhysical` `ContainedIn` | The value of entPhysicalIndex for the physical entity that contains this physical entity. A value of zero indicates this physical entity is not contained in any other physical entity. | Range: 0..2147483647 | Integer | None
`entPhysical` `Class` | An indication of the general hardware type of the physical entity. | `other(1),` `unknown(2),` `chassis(3),` `backplane(4),` `container(5),` `powerSupply(6),` `fan(7),` `sensor(8),` `module(9),` `port(10),` `stack(11)` | Integer | None
`entPhysical` `FirmwareRev` | The vendor-specific firmware revision string for the physical entity. | Size: 0..255 | String | Zero-length string

##

Monitoring System Sensors, Indicators, and ILOM Event Log

Topics |
--- | ---
Description | Links
View and set clock settings | View and Set Clock Settings
View and clear the ILOM event log | View and Clear the ILOM Event Log
Configure remote syslog receiver IP addresses | Configure Remote Syslog Receiver IP Addresses
Configure alert rules | Configure an Alert Rule

### View and Set Clock Settings

Note - You can use the `get` and `set` commands to view and set clock settings with respect to Network Time protocol (NTP) synchronization. For a description of the MIB objects used in this procedure, see ILOM Clock Setting MIB Objects.

1. Log in to a host that has an SNMP tool and the ILOM MIBs installed. For example, type:

`ssh` username`@`snmp_manager_ip_address

`Password:``` password

2. Refer to the following SNMP commands for examples:

- To view the NTP server state, type:

    % snmpget -v2c -cprivate -mALL SNMP_agent_ip_address ilomCtrlNTPEnabled.0

- To set the NTP server state to enabled, type:

    % snmpset -v2c -cprivate -mALL SNMP_agent_ip_address ilomCtrlNTPEnabled.0 i 1

- To view the date and time of the device, type:

    % snmpget -v2c -cprivate -mALL SNMP_agent_ip_address ilomCtrlDateAndTime.0

- To set the date and time of the device, type:

    % snmpset -v2c -cprivate -mALL SNMP_agent_ip_address ilomCtrlDateAndTime.0 s 2008-3-24,4:59:47.0

#### ILOM Clock Setting MIB Objects

The following MIB objects, values, and types are valid for ILOM clock settings.

TABLE 5-2 Valid MIB Objects, Values, and Types for ILOM Clock Settings
MIB Object | Description | Allowed Values | Type | Default
--- | --- | --- | --- | ---
`ilomCtrlDateAndTime` | The date and time of the device. | date/time | String | None
`ilomCtrlNTP` `Enabled` | Specifies whether the Network Time Protocol is enabled. | `true(1),` `false(2)` | Integer | false
ilomCtrlTimezone | The configured timezone string. | Size: 0..255 | String | None

### View and Clear the ILOM Event Log

Note - You can use the `get` command to view the ILOM event log and the `set` command to configure the ILOM event log. For a description of the MIB objects used in this procedure, see ILOM Event Log MIB Objects.

1. Log in to a host that has an SNMP tool and the ILOM MIBs installed. For example, type:

`ssh` username`@`snmp_manager_ip_address

`Password:``` password

2. To view the ILOM event log type for an event log with a record ID of 2, type:

    % snmpget -v2c -cprivate -mALL SNMP_agent_ip_address ilomCtrlEventLogType.2

3. To clear the ILOM event log, type:

    % snmpset -v2c -cprivate -mALL SNMP_agent_ip_address ilomCtrlEventLogClear.0 i 1

#### ILOM Event Log MIB Objects

The following MIB objects, values, and types are valid for ILOM event log settings.

TABLE 5-3 MIB Objects, Values, and Types for Event Log Settings
MIB Object | Description | Allowed Values | Type | Default
--- | --- | --- | --- | ---
`ilomCtrlEventLog RecordID` | The record number for a given event log entry. Note - This object is not accessible. | Range: 1..10000 | Integer | None
`ilomCtrlEventLog Type` | An integer representing the type of event. Note - This object is read-only. | `log(1),` `action2),` `fault(3),` `state(4),` `repair(5)` | Integer | None
`ilomCtrlEventLogTimestamp` | The date and time that the event log entry was recorded. Note - This object is read-only. | date/time | String | None
`ilomCtrlEventLogClass` | An integer representing the class of event. Note - This object is read-only. | `audit(1),` `ipmi(2),` `chassis(3),` `fma(4),` `system(5)` `pcm(6)` | Integer | None
`ilomCtrlEventLog Severity` | The event severity corresponding to the given log entry. Note - This object is read-only. | `disable(1),` `critical(2),` `major(3),` `minor(4),` `down(5` | Integer | None
`ilomCtrlEventLog Description` | A textual description of the event. Note - This object is read-only. | description | String | None
`ilomCtrlEventLog Clear` | Setting this object to true clears the event log. | `true(1),` `false(2)` | Integer | None

### Configure Remote Syslog Receiver IP Addresses

Note - You can use the `get` and `set` commands to view and set IP addresses for a remote Syslog receiver. For a description of the MIB objects used in this procedure, see Remote Syslog Receiver IP Addresses MIB Objects.

1. Log in to a host that has an SNMP tool and the ILOM MIBs installed. For example, type:

`ssh` username`@`snmp_manager_ip_address

`Password:``` password

2. To view a remote syslog destination IP address, type:

    % snmpget -v2c -cprivate -mALL SNMP_agent_ip_address ilomCtrlRemoteSyslogDest1.0

3. To set a remote syslog destination IP address, type:

    % snmpset -v2c -cprivate -mALL SNMP_agent_ip_address ilomCtrlRemoteSyslogDest1.0 s ip_address

#### Remote Syslog Receiver IP Addresses MIB Objects

The following MIB objects, values, and types are valid for remote syslog receiver IP addresses.

TABLE 5-4 MIB Objects, Values, and Types for Remote Syslog Receiver IP Addresses
MIB Object | Description | Values | Type | Default
--- | --- | --- | --- | ---
`ilomCtrlRemoteSyslogDest1` | The IP address of the first remote syslog destination (log host). | ip_address | String | None
`ilomCtrlRemoteSyslogDest2` | The IP address of the second remote syslog destination (log host). | ip_address | String | None

### Configure an Alert Rule

Note - You can use the `get` and `set` commands to view and configure alert rule configurations. For a description of the MIB objects used in this procedure, see Alert Rule Configuration MIB Objects.

1. Log in to a host that has an SNMP tool and the ILOM MIBs installed. For example, type:

`ssh` username`@`snmp_manager_ip_address

`Password:``` password

2. To view the severity level for the alert rule with an AlertID of 2, type:

    % snmpget -v2c -cprivate -mALL SNMP_agent_ip_address ilomCtrlAlertSeverity.2

3. To set the severity level to critical for the alert rule with an AlertID of 2, type:

    % snmpset -v2c -cprivate -mALL SNMP_agent_ip_address ilomCtrlAlertSeverity.2 i 2

#### Alert Rule Configuration MIB Objects

The following MIB objects, values, and types are valid for alert rule settings.

TABLE 5-5 MIB Objects, Values, and Types for Alert Rule Settings
MIB Object | Description | Allowed Values | Type | Default
--- | --- | --- | --- | ---
`ilomCtrlAlert ID` | An integer ID associated with a given alert rule. Note - This object is not accessible. | Range: 0..65535 | Integer | None
`ilomCtrlAlert Severity` | Specifies the mininum event severity that should trigger an alert for a given class. | `disable(1),` `critical(2),` `major(3),` `minor(4),` `down(5)` | Integer | None
`ilomCtrlAlert Type` | Specifies the type of notification for a given alert. If the type is`snmptrap(2`) or `ipmipet(3)`, the `ilomCtrlAlertDestinationip` must be specified. If the type is `email(1)`, the `ilomCtrlAlert DestinationEmail` must be specified. | `email(1)` `snmptrap(2)` `ipmipet(3)` remotesyslog (4) | Integer | None
`ilomCtrlAlert Destinationip` | Specifies the IP address to send alert notifications when the alert type is `snmptrap(2)`, `ipmipet(3)`, or `remotesyslog(4)`. | ip_address | String | None
`ilomCtrlAlert Destination Email` | Specifies the email address to send alert notifications when the alert type is `email(1)`. | email address, size: 0..255 | String | None
`ilomCtrlAlert SNMPVersion` | Specifies the version of SNMP trap that should be used for the given alert rule. | `v1(1),` `v2c(2),` `v3(3)` | Integer | None
`ilomCtrlAlert SNMPCommunity OrUsername` | Specifies the community string to be used when the `ilomCtrlAlertSNMPVersion` property is set to `v1(1)` or `v2c(2)`. Specifies the SNMP user name to use when the `ilomCtrlAlertSNMPVersion` is set to `v3(3)`. | Size: 0..255 | String | None
ilomCtrlAlert EmailEvent ClassFilter | A class name or `all` to filter emailed alerts on. | Size: 0..255 | String | None
`ilomCtrlAlert EmailEventTypeFilter` | A class name or `all` to filter emailed alerts on. | Size 0..255 | String | None

##

Configuring SMTP Client for Email Alert Notifications

Topics |
--- | ---
Description | Links
Configure SMTP Client for Email and alert notification | Configure SMTP Client for Email Notification Alerts

### Before You Begin

- To generate configured Email Notification alerts, you must enable the ILOM client to act as an SMTP client to send the email alert messages. To enable the ILOM client as an SMTP client, you must specify the IP address and port number of an outgoing SMTP email server that will process the email notifications.

- Prior to enabling the ILOM client as an SMTP client, gather the IP address and port number of the outgoing SMTP email server.

- You can use the `get` and `set` commands to configure the SMTP client. For a description of the MIB objects used in this procedure, see SMTP Client MIB Objects and the SUN-ILOM-CONTROL-MIB.

### Configure SMTP Client for Email Notification Alerts

1. Log in to a host that has an SNMP tool and the ILOM MIBs installed. For example, type:

`ssh` username`@`snmp_manager_ip_address

`Password:``` password

2. Refer to the following SNMP commands for examples:

- To view a SMTP client state, type:

    % snmpget -v2c -cprivate -mALL SNMP_agent_ip_address ilomCtrlSMTPEnabled.0

- To set a SMTP client state to enabled, type:

    % snmpset -v2c -cprivate -mALL SNMP_agent_ip_address ilomCtrlSMTPEnabled.0 i 1

- To view a SMTP server IP address, type:

    % snmpget -v2c -cprivate -mALL SNMP_agent_ip_address ilomCtrlSMTPServerip.0

- To set a SMTP server IP address, type:

    % snmpset -v2c -cprivate -mALL SNMP_agent_ip_address ilomCtrlSMTPServerip.0 s ip_address

- To view a SMTP client port number, type:

    % snmpget -v2c -cprivate -mALL SNMP_agent_ip_address ilomCtrlSMTPPortNumber.0

- To set a SMTP client port number, type:

    % snmpset -v2c -cprivate -mALL SNMP_agent_ip_address ilomCtrlSMTPPortNumber.0 i 25

- To view an optional format to identify the sender or the ’from’ address, type:

    % snmpget -mALL -v2c -cprivate SNMP_agent_ipaddress ilomCtrlSMTPCustomSender.0

- To configure an optional format to identify the sender or the ’from’ address, type:

    % snmpset -mALL -v2c -cprivate SNMP_agent_ipaddress ilomCtrlSMTPCustomSender.0 s ‘ilom-alert@HOSTNAME.abc.com’

#### SMTP Client MIB Objects

The following MIB objects, values, and types are valid settings for SMTP clients.

TABLE 5-6 Valid MIB Objects, Values, and Types for SMTP Clients
MIB Object | Property | Allowed Values | Type | Default
--- | --- | --- | --- | ---
`ilomCtrlSMTPEnabled` | Specifies whether or not the SMTP client is enabled. | `true(1),` `false(2)` | Integer | false
`ilomCtrlSMTPServerip` | The IP address of the SMTP server used as a name service for user accounts. | ip_address | String | None
`ilomCtrlSMTPPortNumber` | Specifies the port number for the SMTP client. | Range: 0..65535 | Integer | None

##

Configuring Email Alert Settings

Topics |
--- | ---
Description | Links
Configure email alert settings | View and Configure Email Alert Settings

### View and Configure Email Alert Settings

Note - You can use the `get` and `set` commands to view and configure email alert settings. For a description of the MIB objects used in these commands, see the SUN-ILOM-CONTROL-MIB.

1. Log in to a host that has an SNMP tool and the ILOM MIBs installed. For example, type:

`ssh` username`@`snmp_manager_ipaddress

`Password``:` password

2. Refer to the following SNMP command examples:

- To view the optional format used to identify the sender or the ’from’ address, type:

    % snmpget -mALL -v2c -cprivate SNMP_agent_ipaddress ilomCtrlAlertEmailCustomSender.0

- To set the optional format used to identify the sender or the ’from’ address, type:

    % snmpset -mALL -v2c -cprivate SNMP_agent_ipaddress ilomCtrlAlertEmailCustomSender.0 s ‘ilom-alert@HOSTNAME.abc.com’

- To view an optional string that can be added to the beginning of the message body, type:

    % snmpget -mALL -v2c -cprivate SNMP_agent_ipaddress ilomCtrlAlertEmailMessagePrefix.0

- To define an optional string (for example: BeginMessage) that can be added to the beginning of the message body, type:

    % snmpset -mALL -v2c -cprivate SNMP_agent_ipaddress ilomCtrlAlertEmailMessagePrefix.0 s ‘BeginMessage’

##

Configuring Telemtry Harness Daemon

Topics |
--- | ---
Description | Links
Configure telemetry harness daemon settings | View and Configure Telemetry Harness Daemon Settings

### View and Configure Telemetry Harness Daemon Settings

Note - You can use the `get` and `set` commands to view and configure Telemetry Harness Daemon (THD) settings. For a description of the MIB objects used in these commands, see the SUN-ILOM-CONTROL-MIB.

1. Log in to a host that has an SNMP tool and the ILOM MIBs installed. For example, type:

`ssh` username`@`snmp_manager_ipaddress

`Password``:` password

2. Refer to the following SNMP command examples:

- To view the state of the THD daemon, type:

    % snmpget -mALL -v2c -cprivate SNMP_agent_ipaddress ilomCtrlThdState.0

- To view the control action for THD daemon, type:

    % snmpget -mALL -v2c -cprivate SNMP_agent_ipaddress ilomCtrlThdAction.0

- To set the control action for THD daemon to `suspend`, type:

    % snmpset -mALL -v2c -cprivate SNMP_agent_ipaddress ilomCtrlThdAction.0 i 1

- To view the description of the THD module named `THDMod1`, type:

    % snmpget -mALL -v2c -cprivate SNMP_agent_ipaddress ilomCtrlThdModuleDesc.’THDMod1’

- To view the state of the THD module named `THDMod1`, type:

    % snmpget -mALL -v2c -cprivate SNMP_agent_ipaddress ilomCtrlThdModuleState.’THDMod1’

- To view the control action for the THD module named `THDMod1`, type:

    % snmpget -mALL -v2c -cprivate SNMP_agent_ipaddress ilomCtrlThdModuleAction.’THDMod1’

- To set the control action for the THD module named `THDMod1` to `suspend`, type:

    % snmpset -mALL -v2c -cprivate SNMP_agent_ipaddress ilomCtrlThdModuleAction.0 i 1

- To view the state of the THD instance named `myTHDinstance` that is in the THD class named `myTHDclase`, type:

    % snmpget -mALL -v2c -cprivate SNMP_agent_ipaddress ilomCtrlThdInstanceState.’myTHDclass.myTHDinstance’

- To view the action of the THD instance named `myTHDinstance` that is in the THD class named `myTHDclase`, type:

    % snmpget -mALL -v2c -cprivate SNMP_agent_ipaddress ilomCtrlThdInstanceAction.’myTHDclass.myTHDinstance’

- To set the action of the THD instance named `myTHDinstance` that is in the THD class named `myTHDclase` to `resume`, type:

    % snmpset -mALL -v2c -cprivate SNMP_agent_ipaddress ilomCtrlThdInstanceAction.’myTHDclass.myTHDinstance’ i 2

Copyright © 2010, Oracle and/or its affiliates. All rights reserved.