Skip to main content
Outside service Partner
Hitachi Vantara Knowledge

Configuring SNMP


You can configure HCP to work with SNMP. With SNMP enabled, you can have HCP send system log messages to one or more specified SNMP managers. When you do this, you can use tools in your SNMP environment to perform functions such as sorting the messages, querying for certain events, or forwarding error messages to a mobile device.

To use HCP to send log messages to external SNMP managers, each SNMP manager must be configured to use at least one IPv4 or IPv6 address that is routable from the [hcp_system] network. For this reason, if you specify an IPv6 unique local address (ULA) for an external SNMP manager, then the [hcp_system] network must be configured with an IPv6 ULA that can be used to connect to that SNMP manager.

To send the log messages, HCP uses the arcAdminLogEvent trap in its own management information base (MIB), HCP-MIB. You can download this MIB from the SNMP page of the HCP System Management Console.

HCP can also send notification of certain types of events to the specified SNMP managers. These event types are determined by traps in several standard MIBs available to SNMP clients.

Tenant-level administrators can choose to include tenant log messages along with the system log messages sent to the SNMP managers.

Additionally, with SNMP enabled, you can use SNMP tools to view almost all the system settings available in the System Management Console, as well as other settings available only through standard MIBs. You can also allow or disallow the use of SNMP to change HCP settings such as the shredding rate or whether nodes should respond to ping requests. You can specify IP addresses from which viewing and changing these settings is allowed or denied.

To use SNMP for event notification, receiving log messages, and viewing and modifying system settings, you need to have an SNMP tool installed on your client. SNMP tools are available from multiple sources.

For information on the standard MIB files HCP supports, see SNMP MIB support.

NoteWebHelp.png

Note: When you change the SNMP configuration while SNMP is enabled, SNMP functions are briefly disrupted.

© 2015, 2019 Hitachi Vantara Corporation. All rights reserved.

Log messages sent to SNMP managers


For each system log message about an event, HCP sends the information shown in the table below to the specified SNMP managers.

Information

Field in HCP-MIB

Data type

Severity of the event

hcpAdminLogEventSeverity

INTEGER. Possible values are:

3 — Error

4 — Warning

5 — Notice

Date time the event occurred

hcpAdminLogEventTimestamp

DateAndTime

Message ID

hcpAdminLogEventType

Integer32

Full message text

hcpAdminLogEventMessage

LongDisplayString (up to 1,024 bytes)

You can choose the severity level of the log messages to be sent. You can also choose whether or not to send messages about security events (that is, attempts to log into the System Management Console with an invalid username) and compliance events. Compliance events happen at the namespace level, so these messages are sent to the SNMP managers only if SNMP logging is enabled at the tenant level.

NoteWebHelp.png

Notes: 

System log messages are not guaranteed to arrive at the SNMP managers to which they’re sent. This is because the SNMP protocol uses UDP for data transmission.

Some HCP startup events occur before the internal SNMP server starts. Therefore, messages about these startup events are not sent to SNMP managers.

© 2015, 2019 Hitachi Vantara Corporation. All rights reserved.

Enabling SNMP


You use the SNMP page in the HCP System Management Console to enable and configure SNMP for HCP. You also use this page to test the connections to the SNMP managers that you specify.

To display the SNMP page, in the top-level menu of the System Management Console, select Monitoring SNMP.

RoleWebHelp.png

Roles: To view the SNMP page, you need the monitor, administrator, security, or compliance role. To configure SNMP for HCP and test connections to SNMP managers, you need the administrator or security role.

To enable and configure SNMP for HCP, on the SNMP page:

Specify SNMP settings:

oTo enable all uses of SNMP with HCP, select Enable SNMP at snmp.hcp-domain-name.

oOptionally, select Allow writes/updates of HCP settings through SNMP to allow users to change the HCP system configuration through SNMP. This option applies only when SNMP is enabled.

oTo indicate the version of SNMP you want to use, select either Use version 1 or 2c or Use version 3.

NoteWebHelp.png

Note: SNMP version 1 does not support fields with the Counter64 data type. In the HCP MIB, several fields have that data type. When you use SNMP version 1 to retrieve system information, it will not return values for those fields.

oTo secure access to HCP through SNMP:

For SNMP version 1 or 2c, type the name of a community in the Community field. Community names can contain can be from 1 through 63 characters long and are case sensitive.

For SNMP version 3:

In the New Password field, type a password to go with the system-supplied name in the Username field. Passwords must be at least eight characters long and can contain any valid UTF-8 characters, including white space; however, the recommended usage is to limit the password to only ASCII characters. Passwords are case sensitive.

If you’re modifying the SNMP settings and you leave the New Password field empty, the previously set password remains in effect.

In the Confirm Password field, type the password again.

In the Community field, type a community access string. Community access strings can contain only alphanumeric characters and hyphens (-) and can be from 1 through 63 characters long. These strings are case sensitive.

oTo include log messages about compliance events with the messages sent to the specified SNMP managers, select Send compliance events.

oTo include log messages about security events with the messages sent to the specified SNMP managers, select Send security events.

oIn the Send log messages at this level or higher field, select the severity level of log messages to be sent to the specified SNMP managers:

OFF tells HCP not to send any log messages.

NOTICE sends messages with a severity level of Notice, Warning, or Error.

WARNING sends messages with a severity level of Warning or Error.

ERROR sends only messages with a severity level of Error.

Then click on Update Settings.

TipWebHelp.png

Tip: Before you submit your changes, you can test the connections to the specified SNMP managers, as described in Testing SNMP connections.

Optionally, specify IP addresses to be allowed access to HCP through SNMP. To do this:

1.Click on the Allow tab.

2.Follow the instructions in Adding and removing entries in Allow and Deny lists.

Optionally, specify IP addresses to be denied access to HCP through SNMP. To do this:

1.Click on the Deny tab.

2.Follow the instructions in Adding and removing entries in Allow and Deny lists.

To specify how HCP should handle IP addresses that appear in both or neither of the Allow and Deny lists, select or deselect Allow request when same IP is used in both lists. Changes to this option take effect immediately.

For the effects of this option, see Allow and Deny list handling.

Optionally, specify one or more external SNMP manager IP addresses. For each external SNMP manager that you want to use with HCP, specify the IPv4 or IPv6 address that you want HCP to use to connect to that SNMP manager.

You specify each external SNMP manager IP address as a separate entry in the SNMP trap addresses list. To add an IP address to the SNMP trap addresses list:

1.In the Trap Addresses field, type the IP address. Each entry in this list must be a single IP address. IP address ranges and comma-separated lists are not valid.

2.Click on Add.

The IP address moves into the list below the field.

To remove an external SNMP manager IP address from the list, click on the delete control ( DeleteControl.png ) for that IP address. To remove all the IP addresses from the list, click on Delete All.

NoteWebHelp.png

Note: IP addresses that appear in both the Trap Addresses list and the Deny list do not receive trap notifications.

© 2015, 2019 Hitachi Vantara Corporation. All rights reserved.

Testing SNMP connections


At any time, you can test the connections to the external SNMP managers whose IP addresses appear on the SNMP page. Testing the connections causes HCP to send a message to the target IP addresses. To verify that the connections are working, you need to use your SNMP tools to check that the message arrived.

The message HCP sends to the SNMP managers has a severity level of Notice. Therefore, for the message to be sent successfully, the severity level of messages to be sent must be set to NOTICE.

To test the connections to the specified external SNMP managers:

1.On the SNMP page, click on Test. HCP sends this message to the specified SNMP managers:

User username sent system log test message.

2.Check each SNMP manager to ensure that the message arrived.

If an SNMP manager doesn’t receive the message:

Check that you’ve correctly specified the target IP address.

Check that you can successfully ping the target IP address.

If you’re unable to determine the cause of the problem, please contact your authorized HCP service provider.

© 2015, 2019 Hitachi Vantara Corporation. All rights reserved.

Viewing and downloading the HCP-MIB.txt file


The SNMP MIB for HCP is described in the HCP-MIB.txt file. To use this MIB, you need to download the file to your SNMP tool.

TipWebHelp.png

Tip: You can download the HCP-MIB.txt file even if your user account includes only the monitor role.

To view the HCP-MIB.txt file, click on HCP-MIB.txt on the SNMP page. The HCP-MIB.txt file opens in the System Management Console browser window.

To download the HCP-MIB.txt file:

1.Right-click on HCP-MIB.txt on the SNMP page and select the browser-specific option for downloading the file.

2.Save the file as HCP-MIB.txt in the applicable directory for your SNMP tool.

For more information on the HCP-MIB.txt file, see SNMP MIB support.

© 2015, 2019 Hitachi Vantara Corporation. All rights reserved.

Using SNMP to view or change HCP settings


You can use the fields HCP-MIB and other MIBs to view and, when allowed, change HCP settings. The interface you use for these activities depends on your SNMP tool. Here are examples of viewing and changing HCP settings with the command-line tool net-snmp:

To view the total storage capacity of the HCP system:

Command: snmpget -v 2c -c public -m +/usr/share/snmp/mibs/HCP-MIB.txt
snmp.hcp-ma.example.com HCP-MIB::totalCapacity.0

Response: HCP-MIB::totalCapacity.0 = Counter64: 562110914560

To set the shredding rate to low:

Command: snmpset -v 2c -c public -m +/usr/share/snmp/mibs/HCP-MIB.txt
snmp.hcp-ma.example.com HCP-MIB::shreddingRate.0 i 5000

Response: HCP-MIB::shreddingRate.0 = INTEGER: low(5000)

net-snmp is a publicly available tool. You can download it from http://www.net-snmp.org.

© 2015, 2019 Hitachi Vantara Corporation. All rights reserved.

SNMP MIB support


You can use SNMP with HCP to view and modify system settings and receive notifications of certain types of events. HCP comes with a MIB, defined in the HCP-MIB.txt file, that includes fields and traps specific to the system. HCP also supports many of the standard Linux-based MIBs available with SNMP.

HCP-MIB exposes information about the HCP system as a whole, so you get the same information regardless of which storage node you access. The standard MIBs, on the other hand, expose information about individual nodes, so the information you get applies only to the specific storage node that you access.

You can use many of the fields in HCP-MIB to both view and modify system values. With the fields in the standard MIBs, you can only view system values.

This appendix lists the supported standard MIBs and explains how to find out which fields are exposed through them. (HCP exposes all the fields in HCP-MIB.)

For more information on using SNMP with HCP, see Configuring SNMP. For descriptions of the fields HCP exposes in each supported MIB, including HCP-MIB, see the MIBs themselves. For information on downloading the HCP-MIB.txt file, see Viewing and downloading the HCP-MIB.txt file.

© 2015, 2019 Hitachi Vantara Corporation. All rights reserved.

Supported standard MIB files


The standard MIBs that HCP supports contain fields in subtrees under the mib-2 and ucdavis roots. The fields HCP exposes are in the following MIBs, with exclusions as noted:

With fields under mib-2:

oDISMAN-EVENT-MIB

oHOST-RESOURCES-MIB

oIF-MIB

oIP-FORWARD-MIB

oIP-MIB (excluding these groups: ipAddrTable, ipRouteTable, and ipNetToMediaEntry)

oIPV6-MIB

oMTA-MIB

oNOTIFICATION-LOG-MIB

oRFC1213-MIB (excluding this group: atTable)

oSNMPv2-MIB

oTCP-MIB (excluding this group: tcpConnTable)

oUDP-MIB (excluding this group: udpTable)

With fields under ucdavis:

oLM-SENSORS-MIB

oUCD-DISKIO-MIB

oUCD-DLMOD-MIB

oUCD-SNMP-MIB

You can download:

Files for all these MIBs, except MTA-MIB and RFC1213-MIB, from http://www.net-snmp.org/docs/mibs

The file for MTA-MIB from http://www.oidview.com/mibs/0/MTA-MIB.html

The file for RFC1213-MIB from http://www.oidview.com/mibs/0/RFC1213-MIB.html.

© 2015, 2019 Hitachi Vantara Corporation. All rights reserved.

Walking the MIB


To find out exactly which fields HCP exposes under mib-2 and ucdavis, you can walk the MIB. Walking the MIB means having the SNMP client query HCP for the exposed fields.

How you walk the MIB depends on your SNMP tool. The instruction below uses the command-line tool from the publicly available net-snmp package. You can download this package from http://www.net-snmp.org.

To walk the MIB with net-snmp, you use the snmpwalk command with this format:

snmpwalk-v snmp-version -csnmp-community-name
node-ip-address-or-hostnamemib-root

node-ip-address-or-hostname is a valid front-end IP address or hostname of a storage node in the HCP system. The node that you specify must be running and healthy (that is, it must be available to the system).

This sample snmpwalk command queries the node with the IP address 192.168.210.16 for the fields that HCP exposes in subtrees branching from mib-2:

snmpwalk -v 2c -c public 192.168.210.16 mib-2

© 2015, 2019 Hitachi Vantara Corporation. All rights reserved.