SNMP Agent User Guide
SNMP Agent User Guide
SNMP Agent User Guide
SVOS RF 9.7
MK-97HM85027-08
August 2021
© 2018, 2021 Hitachi, Ltd. All rights reserved.
No part of this publication may be reproduced or transmitted in any form or by any means, electronic or mechanical, including copying and recording,
or stored in a database or retrieval system for commercial purposes without the express written permission of Hitachi, Ltd., or Hitachi Vantara LLC
(collectively “Hitachi”). Licensee may make copies of the Materials provided that any such copy is: (i) created as an essential step in utilization of the
Software as licensed and is used in no other manner; or (ii) used for archival purposes. Licensee may not make any other copies of the Materials.
“Materials” mean text, data, photographs, graphics, audio, video and documents.
Hitachi reserves the right to make changes to this Material at any time without notice and assumes no responsibility for its use. The Materials contain
the most current information available at the time of publication.
Some of the features described in the Materials might not be currently available. Refer to the most recent product announcement for information about
feature and product availability, or contact Hitachi Vantara LLC at https://support.hitachivantara.com/en_us/contact-us.html.
Notice: Hitachi products and services can be ordered only under the terms and conditions of the applicable Hitachi agreements. The use of Hitachi
products is governed by the terms of your agreements with Hitachi Vantara LLC.
By using this software, you agree that you are responsible for:
1. Acquiring the relevant consents as may be required under local privacy laws or otherwise from authorized employees and other individuals; and
2. Verifying that your data continues to be held, retrieved, deleted, or otherwise processed in accordance with relevant laws.
Notice on Export Controls. The technical data and technology inherent in this Document may be subject to U.S. export control laws, including the
U.S. Export Administration Act and its associated regulations, and may be subject to export or import regulations in other countries. Reader agrees to
comply strictly with all such regulations and acknowledges that Reader has the responsibility to obtain licenses to export, re-export, or import the
Document and any Compliant Products.
Hitachi and Lumada are trademarks or registered trademarks of Hitachi, Ltd., in the United States and other countries.
AIX, AS/400e, DB2, Domino, DS6000, DS8000, Enterprise Storage Server, eServer, FICON, FlashCopy, GDPS, HyperSwap, IBM, Lotus, MVS, OS/
390, PowerHA, PowerPC, RS/6000, S/390, System z9, System z10, Tivoli, z/OS, z9, z10, z13, z14, z/VM, and z/VSE are registered trademarks or
trademarks of International Business Machines Corporation.
Active Directory, ActiveX, Bing, Excel, Hyper-V, Internet Explorer, the Internet Explorer logo, Microsoft, the Microsoft Corporate Logo, MS-DOS,
Outlook, PowerPoint, SharePoint, Silverlight, SmartScreen, SQL Server, Visual Basic, Visual C++, Visual Studio, Windows, the Windows logo,
Windows Azure, Windows PowerShell, Windows Server, the Windows start button, and Windows Vista are registered trademarks or trademarks of
Microsoft Corporation. Microsoft product screen shots are reprinted with permission from Microsoft Corporation.
All other trademarks, service marks, and company names in this document or website are properties of their respective owners.
Copyright and license information for third-party and open source software used in Hitachi Vantara products can be found at https://
www.hitachivantara.com/en-us/company/legal.html.
Preface......................................................................................................5
Intended audience............................................................................................... 5
Product version....................................................................................................5
Release notes......................................................................................................5
Changes in this revision.......................................................................................6
Document conventions........................................................................................ 6
Conventions for storage capacity values............................................................. 7
Accessing product documentation.......................................................................8
Getting help..........................................................................................................8
Comments............................................................................................................9
Chapter 1: Introduction........................................................................... 10
SNMP Manager overview.................................................................................. 10
How SNMP works.........................................................................................10
Management Information Base overview..................................................... 11
SNMP Agent configuration.................................................................................11
SNMP Agent overview.......................................................................................12
SNMP traps.................................................................................................. 12
SNMP Agent operations...............................................................................13
SNMP Agent reported errors........................................................................13
Component status information from SNMP Manager........................................ 14
Contents
SNMP Agent User Guide for VSP E Series 3
Deleting SNMP request authentication........................................................ 27
Testing SNMP trap reports.................................................................................27
Chapter 4: Troubleshooting.....................................................................41
Solving SNMP problems....................................................................................41
Glossary.............................................................................................. 43
Contents
SNMP Agent User Guide for VSP E Series 4
Preface
This document describes and provides instructions for using the SNMP Agent on Hitachi
Virtual Storage Platform E series.
Please read this document carefully to understand how to use this product, and maintain a
copy for reference purposes.
Intended audience
This document is intended for system administrators, Hitachi Vantara representatives, and
authorized service providers who install, configure, and operate Hitachi Virtual Storage
Platform E series.
Product version
This document revision applies to the following product versions:
■ VSP E series: 93-05-02 or later
■ SVOS RF 9.7 or later
Release notes
Read the release notes before installing and using this product. They may contain
requirements or restrictions that are not fully described in this document or updates or
corrections to this document. Release notes are available on the Hitachi Vantara Support
Website: https://knowledge.hitachivantara.com/Documents.
Preface
SNMP Agent User Guide for VSP E Series 5
Changes in this revision
Document conventions
This document uses the following typographic conventions:
Convention Description
pairdisplay -g group
(For exceptions to this convention for variables, see the entry for
angle brackets.)
Status-<report-name><file-version>.csv
■ Variables in headings.
| vertical bar Indicates that you have a choice between two or more options or
arguments. Examples:
[ a | b ] indicates that you can choose a, b, or nothing.
Preface
SNMP Agent User Guide for VSP E Series 6
Conventions for storage capacity values
Convention Description
{ a | b } indicates that you must choose either a or b.
Logical capacity values (for example, logical device capacity, cache memory capacity) are
calculated based on the following values:
Preface
SNMP Agent User Guide for VSP E Series 7
Accessing product documentation
Getting help
The Hitachi Vantara Support Website is the destination for technical support of products and
solutions sold by Hitachi Vantara. To contact technical support, log on to the Hitachi Vantara
Support Website for contact information: https://support.hitachivantara.com/en_us/contact-
us.html.
Hitachi Vantara Community is a global online community for Hitachi Vantara customers,
partners, independent software vendors, employees, and prospects. It is the destination to
get answers, discover insights, and make connections. Join the conversation today! Go to
community.hitachivantara.com, register, and complete your profile.
Preface
SNMP Agent User Guide for VSP E Series 8
Comments
Comments
Please send us your comments on this document to [email protected].
Include the document title and number, including the revision level (for example, -07), and
refer to specific sections and paragraphs whenever possible. All comments become the
property of Hitachi Vantara LLC.
Thank you!
Preface
SNMP Agent User Guide for VSP E Series 9
Chapter 1: Introduction
This chapter provides an overview of the SNMP implementation for monitoring Hitachi Virtual
Storage Platform E series storage systems, including the agent and management functions.
Note:
■ SNMP versions v1, v2c, and v3 are supported.
■ An RFC-compliant encryption algorithm is adopted for User-based Security
Model (USM) authentication.
Chapter 1: Introduction
SNMP Agent User Guide for VSP E Series 10
Management Information Base overview
An SNMP manager monitors the devices, which are referred to as managed nodes. Typically,
an SNMP Manager polls the SNMP agents on a periodic basis. The manager receives the
reports from the agents and determines whether the devices are operating normally. If an
abnormal event occurs, an SNMP Agent can report the condition without a request from the
manager, by using a trap message.
When an SNMP manager polls an agent, the following dialogue takes place:
■ An SNMP Manager sends a request packet to an SNMP Agent, which requests data
regarding the status of the managed node.
■ The SNMP Agent sends a response packet back to the SNMP Manager.
■ SNMP uses the TCP/IP User Datagram Protocol (UDP). If the SNMP Agent does not
respond within a specified time period, the SNMP Manager re-sends the request packet.
That time period is set by the system administrator, taking into account the network traffic
and operation policy.
■ If an SNMP Agent again does not respond to the resent packet, the SNMP Manager
assumes that an error has occurred. Depending on the times set for polling and response,
this dialogue can take several seconds.
If an SNMP Agent detects an abnormal event, it sends a trap to the SNMP Manager.
However, if a trap is dropped in transmission, the SNMP Manager does not know that it was
sent. For this reason, you should use both polling and traps to determine whether an
abnormal event has occurred.
Chapter 1: Introduction
SNMP Agent User Guide for VSP E Series 11
SNMP Agent overview
The following figure shows an example of SNMP operations using an SNMP manager.
The SNMP Agent reports disk storage system failures to the manager using the SNMP trap
function.
SNMP traps
An SNMP Agent reports storage system errors to the SNMP Manager using the SNMP trap
function.
When an error occurs, the SNMP Agent issues an SNMP trap to the SNMP Manager that
includes the product number, nickname, reference code, component where the failure
occurred, failure date and time, and detailed information about the failure.
For details about SNMP trap reference codes, see the SIM reference guide.
Chapter 1: Introduction
SNMP Agent User Guide for VSP E Series 12
SNMP Agent operations
The following table lists the types of events that trigger an SNMP Agent trap.
Events Description
Operation Description
Chapter 1: Introduction
SNMP Agent User Guide for VSP E Series 13
Component status information from SNMP Manager
noSuchName ■ There are no MIB objects that are Verify that the name of the
(2) required. (Not supported.) requested object is correct.
■ The GETNEXT REQUEST command
that is specified for the following object
identifier of the last supported MIB
object is received.
genErr (5) Error occurred for other reasons. Retry the operation.
Cache
Power supplies
Batteries
Fans
Others
DB Power supplies
Environments
Drives
The following table lists the status of storage system components, as well as the trap report
functions.
Status Description
Chapter 1: Introduction
SNMP Agent User Guide for VSP E Series 14
Component status information from SNMP Manager
Status Description
Chapter 1: Introduction
SNMP Agent User Guide for VSP E Series 15
Chapter 2: Using SNMP
By using the maintenance utility, you can manage alert settings, SNMP trap notification,
SNMP request authentication, and test SNMP trap reports.
Procedure
1.
In the maintenance utility, open the Alert Notifications window by one of the following
ways:
■ When you use Device Manager - Storage Navigator, from the Maintenance Utility
menu in the main window, select Alert Notifications.
■ When you use Hitachi Storage Advisor Embedded (HSAE), in the navigation bar,
click (Settings), and then select Alert Notifications.
■ When you directly logged in to the maintenance utility, click Administration > Alert
Notifications.
Procedure
1. In the maintenance utility, open the Alert Notifications window.
2. In the Alert Notifications window, click Set Up.
3. In the Set Up Alert Notifications window, select the SNMP tab.
Note: Any IP address that has all values set to zero (0) cannot be specified
for IPv4 and IPv6. The IPv6 address is specified by entering eight
hexadecimal numbers that are separated by colons (:) using a maximum of
4 digits from zero (0) to FFFF, inclusive. The default form of the IPv6
address can be specified.
9. Click OK.
The IP address and community you entered are added to the Registered Sending Trap
Settings table.
10. Confirm the settings, and then click Apply.
Procedure
1. In the maintenance utility, open the Alert Notifications window.
2. In the Alert Notifications window, click Set Up.
3. In the Set Up Alert Notifications window, select the SNMP tab.
4. Under SNMP Agent, click Enable.
5. Under SNMP Version, select v3.
Note: Any IP address that has all values set to zero (0) cannot be specified
for IPv4 and IPv6. The IPv6 address is specified by entering eight
hexadecimal numbers that are separated by colons (:) using a maximum of
4 digits from zero (0) to FFFF, inclusive. The default form of the IPv6
address can be specified.
Note:
If you use a user name that has already been specified for Sending Trap
Setting or Request Authentication Setting, specify the same settings for
the following options that were specified for that name. Otherwise, SNMP
traps might not be sent correctly.
■ Authentication
■ Authentication - Protocol
■ Authentication - Password
■ Encryption
■ Encryption - Protocol
■ Encryption - Key
You can enter up to 32 letters, numbers, and symbols, except the following:
Procedure
1. In the maintenance utility, open the Alert Notifications window.
2. In the Alert Notifications window, click Set Up.
3. In the Set Up Alert Notifications window, select the SNMP tab.
4. Under SNMP Agent, click Enable.
5. Under SNMP Version, select v1 or v2c.
6. Under Registered Sending Trap Settings, select a trap setting that you want to
change, and then click Change.
7. In the Change Sending Trap Setting window, under Community, enter a community
name.
You can enter up to 180 letters, numbers, and symbols, except the following:
9. Click OK.
The IP address and community that you entered are changed to the Registered
Sending Trap Settings table.
10. Confirm the settings, and then click Apply.
Procedure
1. In the maintenance utility, open the Alert Notifications window.
2. In the Alert Notifications window, click Set Up.
3. In the Set Up Alert Notifications window, select the SNMP tab.
4. Under SNMP Agent, click Enable.
5. Under SNMP Version, select v3.
6. Under Registered Sending Trap Settings, select a trap setting that you want to
change, and then click Change.
7. In the Change Sending Trap Setting window, under Send Trap To, select IPv4 or IPv6
and enter an IP address.
Note: Any IP address that has all values set to zero (0) cannot be specified
for IPv4 and IPv6. The IPv6 address is specified by entering eight
hexadecimal numbers that are separated by colons (:) using a maximum of
4 digits from zero (0) to FFFF, inclusive. The default form of the IPv6
address can be specified.
Note:
If you use a user name that has already been specified for Sending Trap
Setting or Request Authentication Setting, specify the same settings for
the following options that were specified for that name. Otherwise, SNMP
traps might not be sent correctly.
■ Authentication
■ Authentication - Protocol
■ Authentication - Password
■ Encryption
■ Encryption - Protocol
■ Encryption - Key
You can enter up to 32 letters, numbers, and symbols, except the following:
b. If you change a key, check the Change Key checkbox and then enter a key.
c. For Re-enter Key, enter the same key for confirmation.
Procedure
1. In the maintenance utility, open the Alert Notifications window.
2. In the Alert Notifications window, click Set Up.
3. In the Set Up Alert Notifications window, select the SNMP tab.
4. Under SNMP Agent, click Enable.
5. Under SNMP Version, select your SNMP version.
6. Under Registered Sending Trap Settings, select one or more specific combinations of
IP address and community or user, and then click Delete.
7. Confirm the settings, and then click Apply.
Procedure
1. In the maintenance utility, open the Alert Notifications window.
2. In the Alert Notifications window, click Set Up.
3. In the Set Up Alert Notifications window, select the SNMP tab.
4. Under SNMP Agent, click Enable.
Note: Any IP address that has all values set to zero (0) cannot be specified
for IPv4 and IPv6. The IPv6 address is specified by entering eight
hexadecimal numbers that are separated by colons (:) using a maximum of
4 digits from zero (0) to FFFF, inclusive. The default form of the IPv6
address can be specified.
9. Click OK
The community and IP address that you entered are added to the Registered Request
Authentication Settings table.
10. Confirm the settings, and then click Apply.
Procedure
1. In the maintenance utility, open the Alert Notifications window.
2. In the Alert Notifications window, click Set Up.
3. In the Set Up Alert Notifications window, select the SNMP tab.
4. Under SNMP Agent, click Enable.
5. Under SNMP Version, select v3.
6. Under Registered Request Authentication Settings, click Add.
7. In the Add Request Authentication Setting window, under User Name, enter a user
name.
Note:
If you use a user name that has already been specified for Sending Trap
Setting or Request Authentication Setting, specify the same settings for
the following options that were specified for that name. Otherwise, SNMP
traps might not be sent correctly.
■ Authentication
■ Authentication - Protocol
■ Authentication - Password
■ Encryption
■ Encryption - Protocol
■ Encryption - Key
You can enter up to 32 letters, numbers, and symbols, except the following:
Procedure
1. In the maintenance utility, open the Alert Notifications window.
2. In the Alert Notifications window, click Set Up.
3. In the Set Up Alert Notifications window, select the SNMP tab.
4. Under SNMP Agent, click Enable.
5. Under SNMP Version, select v1 or v2c.
6. Under Registered Request Authentication Settings, select an authentication setting
that you want to change and then click Change.
7. In the Change Request Authentication Setting window, under Community, enter a
community name.
You can enter up to 180 letters, numbers, and symbols, except the following:
Note: Any IP address that has all values set to zero (0) cannot be specified
for IPv4 and IPv6. The IPv6 address is specified by entering eight
hexadecimal numbers that are separated by colons (:) using a maximum of
4 digits from zero (0) to FFFF, inclusive. The default form of the IPv6
address can be specified.
9. Click OK.
The community and IP address that you entered are changed to the Registered
Request Authentication Settings table.
Procedure
1. In the maintenance utility, open the Alert Notifications window.
2. In the Alert Notifications window, click Set Up.
3. In the Set Up Alert Notifications window, select the SNMP tab.
4. Under SNMP Agent, click Enable.
5. Under SNMP Version, select v3.
6. Under Registered Request Authentication Settings, select an authentication setting
that you want to change, and then click Change.
7. In the Change Request Authentication Setting window, under User Name, enter a
user name.
Note:
If you use a user name that has already been specified for Sending Trap
Setting or Request Authentication Setting, specify the same settings for
the following options that were specified for that name. Otherwise, SNMP
traps might not be sent correctly.
■ Authentication
■ Authentication - Protocol
■ Authentication - Password
■ Encryption
■ Encryption - Protocol
■ Encryption - Key
You can enter up to 32 letters, numbers, and symbols, except the following:
Procedure
1. In the maintenance utility, open the Alert Notifications window.
2. In the Alert Notifications window, click Set Up.
3. In the Set Up Alert Notifications window, select the SNMP tab.
4. Under SNMP Agent, click Enable.
5. Under SNMP Version, select your SNMP version.
6. Under Registered Request Authentication Settings, select one or more specific
combinations of IP address and community or user, and then click Delete.
7. Confirm the settings, and then click Apply.
Procedure
1. In the maintenance utility, open the Alert Notifications window.
2. Select the SNMP tab.
3. Click Send Test SNMP Trap.
Reports the test SNMP trap to the community or user registered in the storage system.
Reports the events registered in the storage system instead of the events that are set on
the SNMP tab. If you want to test the events set on the SNMP tab, click Finish and
apply to the storage system, and then report the test SNMP trap.
4. Verify whether the SNMP trap report (reference code 7fffff) is received by the SNMP
manager that has the IP address specified for Sending Trap Setting in the Alert
Notifications window.
Notes:
1. The nickname "HM900" is used.
2. The object identifier for a failure in a storage system processor would be
.1.3.6.1.4.1.116.5.11.4.1.1.6.1.2.
Specific
Trap Code Trap Object Identifier Description
MIB Support
interface group No
at group
ip group
icmp group
tcp group
udp group
egp group
snmp group
raidExMibRoot(1)
├-raidExMibName(1) Maintenance utility product name
├-raidExMibVersion(2) Maintenance utility firmware version
├-raidExMibAgentVersion(3) Extension MIB internal version
├-raidExMibDkcCount(4) Number of DKC
├-raidExMibRaidListTable(5) List of DKC
├-raidExMibDKCHWTable(6) Disk control device information
├-raidExMibDKUHWTable(7) Disk device information
├-raidExMibTrapListTable(8) Error information list
The following figures show an example extension MIB configuration supported by SNMP
agents, which list all extension MIBs that can be obtained from storage systems.
raidExMibName
raidExMibName indicates the product name.
raidExMibName OBJECT-TYPE
SYNTAX DisplayString
ACCESS read-only
STATUS mandatory
DESCRIPTION "product name."
::={ raidExMibRoot 1 }
raidExMibVersion
raidExMibVersion indicates the maintenance utility firmware version.
raidExMibVersion OBJECT-TYPE
SYNTAX DisplayString
ACCESS read-only
STATUS mandatory
DESCRIPTION "GUM firmware version."
::= { raidExMibRoot 2 }
raidExMibAgentVersion
raidExMibAgentVersion indicates the internal version of the extension MIB.
raidExMibAgentVersion OBJECT-TYPE
SYNTAX DisplayString
ACCESS read-only
STATUS mandatory
DESCRIPTION "Extension agent version."
::= { raidExMibRoot 3 }
raidExMibDkcCount
raidExMibDkcCount suggests the number of a storage system.
raidExMibRaidListTable
raidExMibRaidListTable indicates the storage system.
The following table lists the information displayed for each storage system
Mounted
Name Type Description value Attribute
raidExMibDKCHWTable
raidExMibDKCHWTable indicates the status of the storage system components.
The following table lists the information displayed for each storage system component.
Note:
The status of each component is a single digit which shows the following:
1: Normal.
2: Acute failure detected.
3: Serious failure detected.
4: Moderate failure detected.
5: Service failure detected.
raidExMibDKUHWTable
raidExMibDKUHWTable indicates the status of the storage system components.
The following table lists the information displayed for each disk device component.
MIB
Name Type Description value Attribute
Notes:
1. The status of each component is a single digit which shows the following:
1. Normal.
2. Acute failure detected.
3. Serious failure detected.
4. Moderate failure detected.
5. Service failure detected.
2. The status of environment monitor indicates the status of drives and ENCs in the drive
box, and returns a value indicating the highest failure level.
3. Indicates the drive status in the controller chassis.
raidExMibTrapListTable
raidExMibTrapListTable shows the history of the failure traps.
ACCESS non-accessible
STATUS mandatory
DESCRIPTION "Trap list table index."
INDEX { eventListIndexSerialNumber ,
eventListIndexRecordNo }
::={ raidExMibTrapListTable 1 }
The following table lists the information displayed for each failure.
Chapter 4: Troubleshooting
SNMP Agent User Guide for VSP E Series 41
Solving SNMP problems
Chapter 4: Troubleshooting
SNMP Agent User Guide for VSP E Series 42
Glossary
community name
An SNMP entity in which up to 32 names and up to 32 IP addresses can be registered.
extension trap
An error message generated by a third-party node and sent to the SNMP agent.
failure trap
An error message that indicates a problem within a managed node.
IPv4
Internet Protocol, Version 4
IPv6
Internet Protocol, Version 6
managed device
A network node on which the SNMP Agent software is installed. Using the agent, managed
devices exchange node-specific information with the SNMP management software.
managed node
See managed device.
management information base (MIB)
A virtual database of objects that can be monitored by a network management system. SNMP
uses standardized MIBs that allow any SNMP-based tool to monitor any device defined by a MIB
file.
Simple Network Management Protocol (SNMP)
An industry-standard protocol that is used to manage and monitor network-attached devices for
conditions that warrant administrative attention. The devices can include disk devices, routers, and
hubs. SNMP uses Simple Gateway Management Protocol (SGMP) to manage TCP/IP gateways.
SNMP Agent
Software that is installed on the maintenance utility and responds to queries from SNMP Manager.
SNMP Manager
Software that is installed on the network management station that collects and manages
information from SNMP agents installed in the managed devices on the network.
SNMP trap
An event generated by an SNMP agent from the managed resource that communicates an event,
such as an error or failure.
user datagram protocol (UDP)
Software that requests data regarding the status of a managed node.
Glossary
SNMP Agent User Guide for VSP E Series 43
Hitachi Vantara
Corporate Headquarters Contact Information
2535 Augustine Drive USA: 1-800-446-0744
Santa Clara, CA 95054 USA Global: 1-858-547-4526
HitachiVantara.com | community.HitachiVantara.com HitachiVantara.com/contact