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.
Log messages sent to SNMP managers
For each system log message about an event, HCP sends the information shown in the following table to the specified SNMP managers.
| Information | Field in HCP-MIB | Data type |
| Severity of the event | hcpAdminLogEventSeverity |
INTEGER. Possible values are:
|
| 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 user name) 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.
Some HCP startup events occur before the internal SNMP server starts. Therefore, messages about these startup events are not sent to SNMP managers.
Enabling and configuring 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 .
Enabling SNMP for HCP
You can enable SNMP for HCP by going to the SNMP page.
Before you begin
Procedure
Specify SNMP settings.
To enable all uses of SNMP with HCP, select Enable SNMP at snmp.hcp-domain-name.
Optionally, 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.
To indicate the version of SNMP you want to use, select either Use version 1 or 2c or Use version 3.
NoteSNMP 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.To 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.
To secure access to HCP through SNMP 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.
To include log messages about compliance events with the messages sent to the specified SNMP managers, select Send compliance events.
To include log messages about security events with the messages sent to the specified SNMP managers, select Send security events.
In 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.
Click Update Settings.
TipBefore you submit your changes, you can test the connections to the specified SNMP managers
Specifying IP addresses to be allowed access to HCP through SNMP
Optionally, you can specify IP addresses to be allowed access to HCP through SNMP.
Before you begin
Procedure
On the SNMP page, click the Allow tab.
To add an entry to an Allow or Deny list, in the field above the list, type the entry you want and click Add.
To remove a single entry from an Allow or Deny list, click the delete control (
) for that entry.To remove all entries, click Delete All.
Results
Specifying IP addresses to be denied access to HCP through SNMP
Optionally, you can specify IP addresses to be denied access to HCP through SNMP.
Before you begin
Procedure
On the SNMP page, click the Deny tab.
To add an entry to an Allow or Deny list, in the field above the list, type the entry you want and click Add.
To remove a single entry from an Allow or Deny list, click the delete control (
) for that entry.To remove all entries, click Delete All.
Results
Specifying how HCP should handle IP addresses that appear in both or neither of the 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 on the SNMP page. Changes to this option take effect immediately.
Specifying one or more external SNMP manager IP addresses
Optionally, you can 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. You can add an IP address to the SNMP trap addresses list.
Before you begin
Procedure
On the SNMP page, 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.
Click Add.
The IP address moves into the list below the field.To remove an external SNMP manager IP address from the list, click the delete control (
) for that IP address.To remove all the IP addresses from the list, click Delete All.
Results
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.
Before you begin
Procedure
On the SNMP page, click Test.
HCP sends this message to the specified SNMP managers:User username sent system log test message.Check each SNMP manager to ensure that the message arrived.
Next steps
- 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.
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.
Before you begin
Procedure
To view the HCP-MIB.txt file, click HCP-MIB.txt on the SNMP page.
To download the HCP-MIB.txt file, right-click HCP-MIB.txt on the SNMP page and select the browser-specific option for downloading the file.
Save the file as HCP-MIB.txt in the applicable directory for your SNMP tool.
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.0Response:
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 5000Response:
HCP-MIB::shreddingRate.0 = INTEGER: low(5000)
net-snmp is a publicly available tool.