Supported Target Versions
Hitachi NAS Platform 4040, 4100 and 4060.
Firmware version of HNAS Server should be greater than 12.4.
FULL discovery support requires gateway version 15.0.0 or above.

Application Version and Upgrade Details

Application VersionBug fixes / Enhancements
3.0.0API statistics, metric labels and API timeouts.

Introduction

Hitachi Network attached Storage (HNAS) storage systems are discovered via an SNMP agent that can be configured using the embedded System Management Unit (SMU). When an SNMP discovery finds a HNAS server’s IP address, a Storage Device node representing whether a Cluster or a HNAS Standalone Server is created. The creation or confirmation of the Storage Device node triggers the appropriate storage discovery pattern. The storage discovery pattern continues discovery of the storage entity using further SNMP requests to discover the associated storage components. Once discovered, the storage entities are modeled in BMC Discovery.

OpsRamp integrates with HNAS using REST APIs exposed through HNAS gateways.

Key Use cases

Discovery Use cases

  • It discovers the Hitachi HNAS Storage device.

                 • Hitachi NAS File Device
                         •Hitachi NAS Nodes(Component-of file device)
                         •Hitachi NAS VirtualServers(component-of file device)
                         •Hitachi NAS Storage Pools(Component-of file device)
                                Hitachi NAS File Systems-(Component of Storage pools)
                         • Hitachi NAS System Drives(Component-of file device)

Monitoring Use cases

  • Provides metrics related to storage management components and storage server statistics.
  • Concern alerts will be generated for each metric to notify the administrator regarding the issue with the resource.

Prerequisites

  • OpsRamp Nextgen Gateway supported version 14.0.0 and above.
  • OpsRamp Classic Gateway supported version 14.0.0 and above.
    Note: OpsRamp recommends using the latest Gateway version for full coverage of recent bug fixes, enhancements, etc.

Application Migration

  1. Check for the gateway version as a prerequisite step - classic gateway-12.0.1 and above.
    Notes:

    • You only have to follow these steps when you want to migrate from sdk 1.0 to sdk 2.0.
    • For the first time installation below steps are not required.
  2. Disable all configurations associated with sdk 1.0 adaptor integration application.

  3. Install and Add the configuration to that sdk 2.0 application.
    Note: refer to Configure and Install the Hitachi NAS Integration & View the Hitachi NAS Details sections of this document.

  4. Once all discoveries are completed with the sdk 2.0 application, follow any one of the approaches.

    • Direct uninstallation of the sdk 1.0 adaptor application through the uninstall API with skipDeleteResources=true in the DELETE request.

      End-Point: https://{{host}}/api/v2/tenants/{tenantId}/integrations/installed/{installedIntgId}

      Request Body:

          {
          "uninstallReason": "Test",
          "skipDeleteResources": true
          }


      (OR)

    • Delete the configuration one by one through the Delete adaptor config API with the request parameter as skipDeleteResources=true in the DELETE request.

      End-Point: https://{{host}}/api/v2/tenants/{tenantId}/integrations/installed/config/{configId}?skipDeleteResources=true.

    • Finally, uninstall the adapter application through API with skipDeleteResources=true in the DELETE request.

      End-Point: https://{{host}}/api/v2/tenants/{tenantId}/integrations/installed/{installedIntgId}

      Request Body:

              {
          "uninstallReason": "Test",
          "skipDeleteResources": true
      }

    Unassign template (or) delete the empty graphs for SDK 1.0
    1. Navigate to Infrastructure > Resource > Hitachi HNAS.
    2. Select the resource and click Metric.
    3. Copy the Template name.
    Hitachi HNAS - Update Adaptor Configuration
    1. Navigate to Setup > Monitoring > Template.
    2. Right click on the Search By Template Name search box, and click Paste on the Quick Access Toolbar.
    Hitachi HNAS - Update Adaptor Configuration
    1. Click the Device number. The Devices screen appears.
    Hitachi HNAS - Update Adaptor Configuration
    1. Select the resource and click Unassign. The confirmation message is displayed.
    Hitachi HNAS - Update Adaptor Configuration
    1. Select the Also delete the associated graphs checkbox. and click Yes.
    Hitachi HNAS - Update Adaptor Configuration

Supported Metrics

Click here to view the supported metrics
HNAS ComponentMetric NameMetric Display NameUnitsApplication Version
Hitachi NAS File Devicehnas_filedevice_Statushnas filedevice status
  • 1-ROBUST
  • 2-CRITICAL
  • 3-DEGRADED
  • 0-UNKNOWN
2.0.0
hnas_node_counthnas node countcount2.0.0
hnas_virtualserver_Counthnas virtual server countcount2.0.0
hnas_Api_Statisticshnas API Statistics3.0.0
Hitachi NAS Storage Poolshnas_storagepool_Healthstatushnas storage pool healthBOOLEAN2.0.0
hnas_storagepool_Freecapacityhnas storage pool free capacityBytes2.0.0
hnas_storagepool_Usedcapacityhnas storage pool used capacityBytes2.0.0
hnas_storagepool_Capacityutilizationhnas storage pool percentagePercentage2.0.0
SystemDrivehnas_systemdrive_Capacityhnas system drives capacityBytes2.0.0
hnas_systemdrive_Statushnas device system drives status
  • 1 - OK
  • 2 - OFFLINE
  • 3 - FORMATTING
  • 4 - SECONDARY
  • 5 - WRITE_PROTECTED
  • 6 - DISCONNECTED
  • 7 - FAILED
  • 8 - FIRST_INVALID
  • 9 - INITIALIZING
  • 0 - NOT_PRESENT
2.0.0
hnas_systemdrive_IsAccessAllowedhnas system drives is access allowedBOOLEAN2.0.0
hnas_systemdrive_IsAssignedToStoragePoolhnas system drives is assigned to storage poolBOOLEAN2.0.0
hnas_systemdrive_IsMirroredhnas system drive is mirroredBOOLEAN2.0.0
hnas_systemdrive_IsMirrorPrimaryhans system drives is mirror primaryBOOLEAN2.0.0
Hitachi NAS VirtualServerhnas_virtualserver_Statushnas virtual server status
  • 1 - ONLINE
  • 2 - NOT_CONFIGURED
  • 3 - DISABLED
  • 0 - OFFLINE
2.0.0
hnas_evs_migration_Statushnas virtual server migration statusBoolean2.0.0
Hitachi NAS Nodeshnas_node_Statushnas node status
  • 1 - ONLINE
  • 2 - NOT_UP
  • 3 - DEAD
  • 4 - INVALID
  • 5 - UP
  • 6 - DORMANT
  • 0 - UNKNOWN
2.0.0
hnas_node_disk_ReadLatencyhnas disk read latency for nodesmilliSeconds2.0.0
hnas_node_diskstripe_WriteLatencyhnas disk stripe write latencymilliSeconds2.0.0
hnas_node_disk_WriteLatencyhnas disk write latencymilliSeconds2.0.0
hnas_node_ethernet_Throughput_rxhnas ethernet throughput rxMbps2.0.0
hnas_node_fibrechannel_Throughput_rxhnas fibre channel throughput for rxMbps2.0.0
hnas_node_fibrechannel_throughput_txhnas fibre channel throughput for txMbps2.0.0
hnas_node_fsi_CacheUsagehnas node fsi cache usagePercentage2.0.0
hnas_node_HeapUsagehnas node heap usagePercentage2.0.0
hnas_node_Mfb_loadhnas node mfb UsagePercentage2.0.0
hnas_node_Mmb_loadhnas node mmb load percentagePercentage2.0.0
hnas_node_TotalOperationhnas total operations per sec for nodePerSec2.0.0
hnas_node_nvram_WaitedAllocshnas nvram waited allocsCount2.0.0
hnas_node_PI_tcpSockets_receiveFibreshnas pi and tcp socket receive fibresCount2.0.0
hnas_node_Running_bossock_fibreshnas running bossock fibresCount2.0.0
hnas_node_filesystem_Opspersechnas file system operations per sec for each nodePer Sec2.0.0
hnas_node_virus_scanCounthnas virus scan countCount2.0.0
hnas_node_virus_scanCleancounthnas virus scan clean countCount2.0.0
hnas_node_virus_scanErrorshnas virus scan errorsCount2.0.0
hnas_node_virus_scanInfectionsFoundhnas virus scan infections foundCount2.0.0
hnas_node_virus_scanActionsTakenhnas virus scan actions takenCount2.0.0
hnas_node_virus_scanInfectionsRepairedhnas virus scan infections repairedCount2.0.0
hnas_node_virus_scanfiles_DeleteCounthnas virus scan files delete countCount2.0.0
hnas_node_virus_scanfiles_QuarantinedCounthnas virus scan files quarantined countCount2.0.0
hnas_node_fibre_channel_PortStatushnas fibre channel port statusENUM(UP)2.0.0
hnas_node_iscsi_Current_sessionshnas iscsi current sessionsCount2.0.0
hnas_node_iscsi_Current_connectionshnas iscsi current connectionsCount2.0.0
hnas_node_tcpip_Failed_connectionshnas tcpip failed connectionsCount2.0.0
hnas_node_nvram_Sizehnas nvram sizeGiga Bytes2.0.0
hnas_node_nvram_MaxUsehnas nvram maximum useGiga Bytes2.0.0
hnas_node_nvram_CurrentUsehnas nvram currently in useMega Bytes2.0.0
hnas_node_nvram_Utilizationhnas nvram utilizationPercentage2.0.0
hnas_node_snmp_input_General_errorshnas snmp input general errorsCount2.0.0
hnas_node_snmp_input_AsnParse_errorshnas snmp input asn parse errorsCount2.0.0
hnas_node_snmp_output_Packetshnas snmp output packetsCount2.0.0
hnas_node_snmp_output_GeneralErrorshnas snmp output general errorsCount2.0.0
hnas_node_snmp_output_Trapshnas snamp output trapsCount2.0.0
hnas_node_snmp_drops_SilentDropshnas snmp silent dropsCount2.0.0
hnas_node_snmp_drops_ProxyDropshnas snmp proxy dropsCount2.0.0
hnas_node_ftp_sessions_Activehnas ftp active sessionsCount2.0.0
hnas_node_ftp_sessions_Total_sessionshnas ftp total sessionsCount2.0.0
hnas_node_ftp_data_incoming_ActiveSessionshnas ftp data incoming active sessionsCount2.0.0
hnas_node_ftp_files_outgoing_ActiveSessionshnass ftp data outgoing active sessionsCount2.0.0
hnas_node_ftp_files_Total_outgoinghnas ftp files total outgoingCount2.0.0
hnas_node_ftp_files_Total_incominghnas ftp files total incomingCount2.0.0
hnas_node_ftp_Data_incominghnas ftp data incomingCount2.0.0
hnas_node_ftp_Data_outgoinghnas ftp data outgoingCount2.0.0
hnas_node_ftp_data_incoming_ActiveSessionshnas ftp data incoming active sessionsCount2.0.0
hnas_node_ftp_data_outgoing_ActiveSessionshnas ftp data outgoing active sessionsCount2.0.0
hnas_node_cifs_smb_statistics_ConnectionsCounthnas cifs smb connectionsCount2.0.0
hnas_node_cifs_smb_statistics_SharesMappedCounthnas cifs smb shares mapped connectionsCount2.0.0
hnas_node_cifs_smb_TransportDisconnectshnas cifs smb transport disconnectsCount2.0.0
hnas_node_cifs_smb_UnorphanedFilereopenshnas cifs smb unorphaned fies reopensCount2.0.0
hnas_node_cifs_smb_Durreopenedfileidallocfailureshnas cifs smb durreopened file id alloc failuresCount2.0.0
hnas_node_cifs_smb_Durorphanfilereopenfailureshnas cifs smb dur orphan file reopen failuresCount2.0.0
hnas_node_cifs_smb_Durpreserveorphanfailureshnas cifs smb dur preserve orphan failuresCount2.0.0
hnas_ethernet_Interfaceutilhnas cifs smb dur preserve orphan failuresCount2.0.0
hnas_transmit_Rate_Instantaneoushnas ethernet transmit rate instantaneousMb/sec2.0.0
hnas_transmit_rate_Peakhnas ethernet transmit rate peakMb/sec2.0.0
hnas_receive_rate_Instantaneoushnas ethernet receive rate instantaneousMb/sec2.0.0
hnas_receive_rate_Peakhnas ethernet receive rate PeakMb/sec2.0.0
Hitachi NAS FileSystemshnas_filesystem_Freecapacityhnas filesystem free capacityBytes2.0.0
hnas_filesystem_Usedcapacityhnas file system used capacityBytes2.0.0
hnas_filesystem_Logicalfreecapacityhnas file system logical free capacityBytes2.0.0
hnas_filesystem_Utilizationhnas file system percentagePercentage2.0.0
hnas_filesystem_Statushnas file system status
  • 1 - MOUNTED
  • 2 - CHECKING
  • 3 - FAILING
  • 4 - FIXING
  • 5 - MOUNTING
  • 6 - FORMATTING
  • 7 - NOT_MOUNTED
  • 8 - NOT_FOUND
  • 9 - VOLUME_NOT_AVAILABLE_TO_BS
  • 0 - VOLUME_STATE_LAST
2.0.0
hnas_filesystem_IsDedupeEnabledhnas filesystem isdedupeenabledBOOLEAN2.0.0
hnas_filesystemquotas_ByteQuotaUtilizationhnas file system byte quotas utilization2.0.0
hnas_filesystemquotas_FileQuotaUtilizationhnas file system file quotas utilization2.0.0
hnas_filesystemquotas_ByteUsagehnas file system quotas byte usage hard settingGB2.0.0
hnas_filesystemquotas_FileUsagehnas file system quotas file usagecount2.0.0
hnas_filesystemquotas_byteusageHardSettinghnas file system quotas byte usage hard settingBoolean2.0.0
hnas_filesystemquotas_fileusageHardSettinghnas file system quotas file usage hard settingBoolean2.0.0
hnas_virtualvolumequotas_FileQuotaUtilizationhnas virtual volume file quotas utilizationpercent2.0.0
hnas_virtualvolumequotas_ByteQuotaUtilizationhnas virtual volume byte quotas utilizationpercent2.0.0
hnas_virtualvolumequotas_byteusagehnas virtual volume quotas byte usageGB2.0.0
hnas_virtualvolumequotas_fileusagehnas virtual volume quotas file usageCount2.0.0
hnas_virtualvolumequotas_byteusageHardSettinghnas virtual volume quotas byte usage hard settingBoolean2.0.0
hnas_virtualvolumequotas_fileusageHardSettinghnas virtual volume quotas file usage hard settingBoolean2.0.0
hnas_object_replication_BytesTransferredhnas object replication bytes transmitted rateMb/sec2.0.0
hnas_object_replication_BytesRemaininghnas object replication bytes remainingBytes2.0.0
hnas_object_replication_BytesTransferred_Ratehnas object replication bytes transmitted rate2.0.0
hnas_object_replication_Statushnas object replication status2.0.0

Default Monitoring Configurations

Hitachi NASs has default Global Device Management Policies, Global Templates, Global Monitors and Global metrics in OpsRamp. You can customize these default monitoring configurations as per your business use cases by cloning respective global templates and global Device Management Policies. OpsRamp recommends performing the below activity before installing the application to avoid noise alerts and data.

  1. Default Global Device Management Policies

    OpsRamp has a Global Device Management Policy for each Native Type of Hitachi Nas .We can find those Device Management Policies at Setup > Resources > Device Management Policies, search with suggested names in global scope. Each Device Management Policy follows below naming convention:

    {appName nativeType - version}

    Ex: hitachi-nas Hitachi NAS File Device- 2(i.e, appName = hitachi-nas, nativeType =Hitachi NAS File Device, version = 2)

  2. Default Global Templates

    OpsRamp has a Global template for each Native Type of hitachi-nas. We can find those templates at Setup > Monitoring > Templates, search with suggested names in global scope. Each template follows below naming convention:

    {appName nativeType 'Template' - version}

    Ex: hitachi-nas Hitachi NAS File Device Template - 2 (i.e, appName = hitachi-nas, nativeType = Hitachi NAS File Device, version = 2)

  3. Default Global Monitors

    OpsRamp has a Global Monitors for each Native Type which has monitoring support. You can find those monitors at Setup > Monitoring > Monitors, search with suggested names in global scope. Each Monitors follows below naming convention:

    {monitorKey appName nativeType - version}

    Ex: Hitachi NAS File Device Monitor hitachi-nas Hitachi NAS File Device 2 (i.e, monitorKey = Hitachi NAS File Device Monitor, appName = hitachi-nas, nativeType = Hitachi NAS File Device, version = 2)

Configure and Install the Hitachi NAS Integration

  1. From All Clients, select a client.
  2. Go to Setup > Account.
  3. Select the Integrations and Apps tab.
  4. The Installed Integrations page, where all the installed applications are displayed.
    Note: If there are no installed applications, it will navigate to the ADD APP page.
  5. Click + ADD on the Installed Integrations page. The Available Integrations and Apps page displays all the available applications along with the newly created application with the version.
    Note: You can even search for the application using the search option available. Also you can use the All Categories option to search.
Hitachi NAS
  1. Click ADD in the Hitachi NAS application.
  2. In the Configurations page, click + ADD. The Add Configuration page appears.
  3. Enter the below mentioned BASIC INFORMATION:
FunctionalityDescription
NameEnter the name for the configuration.
Host Name / IP AddressEnter the Host name or the IP address.
PortAPI Port information

Note: By default 844 is selected.
Serial NumberEnter the serial number.
CredentialsSelect the credentials from the drop-down list.

Note: Click + Add to create a credential.

Notes:

  • By default the Is Secure checkbox is selected.
  • Host Name / IP Address and Port should be accessible from Gateway.
  • Select the following:
    • App Failure Notifications: if turned on, you will be notified in case of an application failure that is, Connectivity Exception, Authentication Exception.
  1. Select the below mentioned CUSTOM ATTRIBUTE:
FunctionalityDescription
Custom AttributeSelect the custom attribute from the drop down list box.
ValueSelect the value from the drop down list box.

Note: The custom attribute that you add here will be assigned to all the resources that are created by the integration. You can add a maximum of five custom attributes (key and value pair).

  1. In the RESOURCE TYPE section, select:
    • ALL: All the existing and future resources will be discovered.
    • SELECT: You can select one or multiple resources to be discovered.
  2. In the DISCOVERY SCHEDULE section, select Recurrence Pattern to add one of the following patterns:
    • Minutes
    • Hourly
    • Daily
    • Weekly
    • Monthly
  3. Click ADD.
Hitachi NAS

Now the configuration is saved and displayed on the configurations page after you save it.
Note: From the same page, you may Edit and Remove the created configuration.

  1. Click NEXT.
  2. In the Installation page, select an existing registered gateway profile, and click FINISH.
Hitachi NAS
  1. Below are the optional steps you can perform on the Installing page.
    • Under the ADVANCED SETTINGS, select the Bypass Resource Reconciliation checkbox.
      Note: To Bypass Resource Reconciliation for the same resource discovered by multiple applications, two separate resources will be created with their respective attributes from the individual discoveries.
Hitachi NAS
  • Click +ADD to create a new collector by providing a name or use the pre-populated name.
Hitachi NAS
  1. Select an existing registered profile.
Hitachi NAS
  1. Click FINISH.

    The integration is now installed and displayed on the Installed Integration page. Use the search field to find the installed integration.

Modify the Configuration

View the Hitachi NAS Details

The Hitachi NAS integration is displayed in the Infrastructure >Search > Storage Arrays > Hitachi-Nas. You can navigate to the Attributes tab to view the discovery details, and the Metrics tab to view the metric details for Hitachi NAS.

Hitachi NAS
Hitachi NAS

Resource Filter Input Keys

Hitachi NAS application resources are filtered and discovered based on below keys:

Click here to view the Supported Input Keys
Resource TypeSupported Input Keys
All TypesresourceName
hostName
aliasName
dnsName
ipAddress
macAddress
os
make
model
serialNumber

Supported Alert Custom Macros

Customize the alert subject and description with below macros then it will generate alert based on customisation.
Supported macros keys:

Click here to view the alert subject and description with macros

                                ${resource.name}

                                ${resource.ip}

                                ${resource.mac}

                                ${resource.aliasname}

                                ${resource.os}

                                ${resource.type}

                                ${resource.dnsname}

                                ${resource.alternateip}

                                ${resource.make}

                                ${resource.model}

                                ${resource.serialnumber}

                                ${resource.systemId}

                                ${Custome Attributes in the resource}

                                ${parent.resource.name}

Risks, Limitations & Assumptions

  • Application can handle Critical/Recovery failure notifications for below two cases when user enables App Failure Notifications in configuration:
    • Connectivity Exception
    • Authentication Exception
  • Application will not send any duplicate/repeat failure alert notification until the already existing critical alert is recovered.
  • Using metrics for monitoring the resources and generating alerts when the threshold values are breached.
  • Application cannot control monitoring pause/resume actions based on above alerts.
  • This application supports both Classic Gateway and NextGen Gateway.
  • No support of showing activity log and applied time.
  • The minimum support version for the option to get Latest snapshot metric is nextgen-14.0.0.
  • Alerts generated for metrics that are configured as per defined integration.