Installation & Configuration Guide - Blue Medora · PDF file4 Blue Medora VMware vRealize...

VMWARE VREALIZE OPERATIONS MANAGEMENT PACK FOR

NetApp Storage

Installation & Configuration Guide

2 Blue Medora VMware vRealize Operations Management Pack for NetApp Storage Installation & Configuration Guide

NOTE: This document supports the version of each product listed, as well as all subsequent versions, until a new edition replaces it.

You can find the most up-to-date technical documentation on the Blue Medora support site at: http://support.bluemedora.com.

The Blue Medora website also provides the latest product updates. If you have comments about this documentation, submit your feedback to: [email protected].

1. Purpose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32. Installation and Configuration Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

2.1 NetApp Least Privileged User Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . 43. Licensing Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44. Upgrading the Management Pack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

4.1 Back up the properties file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55. Installing the Management Pack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

5.1 Uploading the Installation File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65.2 Adding a License Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

6. Configuring the Management Pack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96.1 Setting Up a Resource Group to Filter Resources* . . . . . . . . . . . . . . . . . . . 96.2 Creating an Adapter Instance and Credential . . . . . . . . . . . . . . . . . . . . . . . . .106.3 Configuring the NetApp SLM Server for HTTPS . . . . . . . . . . . . . . . . . . . . . .146.4 Configuring the NetApp DFM Server to Collect Metrics* . . . . . . . . . . .156.5 Manually Discovering Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .166.6 Validating Data Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .186.7 Modifying Adapter Instance Properties* . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .196.8 Disabling or Collapsing Resource Kinds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .216.9 Disabling Status Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .226.10 Filtering Out Unwanted Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22

7. Appendix I: Management Pack Folders and Files . . . . . . . . . . . . . . . . . . . . . . . . . . .238. Appendix II: Revision Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24

TABLE OF CONTENTS

http://support.bluemedora.com

mailto:support%40bluemedora.com?subject=


1. Purpose

The Blue Medora VMware vRealize Operations (vROps) Management Pack for NetApp Storage Installation and Configuration Guide describes how to install and configure Blue Medora’s VMware vRealize Operations Management Pack for NetApp Storage.

2. Installation and Configuration Requirements

Before installing and configuring the Management Pack for NetApp Storage, ensure your system meets the following requirements:

Table 1: Management Pack Installation & Configuration Requirements

VREALIZE OPERATIONS (VROPS) REQUIREMENTS

NETAPP STORAGE REQUIREMENTS

VERSION(S) vRealize Operations v6.2+(Advanced or Enterprise edition)

The Management Pack for NetApp Storage is compatible with the following NetApp management systems:1. NetApp DFM/OCUM 5.x:NetApp OnCommand Unified Manager (OCUM, a.k.a. DFM), 5.1x or 5.2x-or-2. NetApp SLM/API Services:

• Direct-attached mode: SLM 1.0 RC1 or API Services 1.2+ connected directly to NetApp management systems

NOTE: When API Services 1.2+ is directly connected to NetApp ONTAP, no OCUM-related events will be returned.

-or-• Indirect-attached mode: SLM 1.0 RC1 or

API Services 1.0+ connected via OnCommand Performance Manager (OCPM) and OCUM*

NOTE: If using the indirect-attached mode for SLM/API Services, refer to NetApp’s compatibility documentation for details regarding which versions of OCPM and OCUM are compatible with the SLM/API Services version you are using.

CREDENTIALS N/A DFM/SLM/API Services server User Name/Password

NOTE: Refer to section “2.1 NetApp Least Privileged User Requirements” for the minimum user permissions required for the Management Pack.

CONNECTION vROps hostname or IP address DFM/SLM/API Services server hostname or IP addressThe machine where you install the Management Pack must be able to access the server through the following open ports on the respective server:

• DFM: port 8088• SLM/API Services: port 8443


2.1 NetApp Least Privileged User Requirements

Depending on the type of NetApp server being used, the least privileged user requirement for the Management Pack for NetApp storage may vary. Refer to the table below for details.

Table 2: Minimum User Permissions

SERVER TYPE MINIMUM PERMISSIONS

AUTO FILER CONFIGURATION* QOS/SECONDARY IP**

OCUM 5.1/5.2 7-mode Global Read Global Full Control (DFM:Core.Control) Global Full Control

OCUM 5.1/5.2 Cluster-mode Global Read N/A Global Full Control

SLM/API Servces Monitor credentials N/A Monitor credentials

*NOTE: Auto Filer is only available for DFM servers set up for 7-mode systems. When you set the Auto Filer Configuration option for the adapter instance to True, the DFM server user account must have Global Full Control permissions. If it is set to False, only Global Read permissions are required.

**NOTE: QoS and Secondary IP Addresses require Global Full Control because they are only available via the DFM Proxy, which makes calls directly to the NetApp system.

3. Licensing Requirements

When purchased individually, the Management Pack for NetApp Storage is licensed per number of NetApp systems.

Alternatively, customers who have purchased Blue Medora’s True Visibility Suite (Standard, Advanced, or Enterprise) can access all management packs within that suite (and the edition below it, if applicable). The Management Pack for NetApp Storage is part of Blue Medora’s Advanced True Visibility Suite (TVS), which means a TVS Advanced license or higher is required to use it. For more information, visit http://www.bluemedora.com/true-visibility-suite-for-vmware/.

A license key will be provided by Blue Medora when the Management Pack or True Visibility Suite is purchased and must be added as a NetApp Storage Adapter License within vRealize Operations before the Management Pack can be configured and used. Refer to section “5.2 Adding a License Key” for details.

http://www.bluemedora.com/true-visibility-suite-for-vmware/



4. Upgrading the Management Pack

NOTE: On upgrade from any build before 6.0.10100015, some previously collected LUNs may now be represented as LUN VVOLs. The LUN objects may be removed from vRealize.

Before upgrading to a newer version of the Management Pack (i.e., uploading a new .pak file), we recommend the following tasks:

• Back up the properties file

4.1 Back up the properties file

The properties file can be found at: $VCOPS_BASE/user/plugins/inbound/netapp_adapter3/conf/netapp.properties.

For the 6.2.10201002 release of the Management Pack, the #### DFM and API Services #### section of the properties file has been modified to accommodate collapsing certain resource kinds into parent resource kinds. If you will be making use of this feature, take care when modifying the values within that section of the properties file. Refer to section “6.8 Disabling or Collapsing Resource Kinds” for more information.


5. Installing the Management Pack

Installing the Management Pack in vRealize Operations involves completing the following tasks:• Uploading the Installation File• Adding a License Key

5.1 Uploading the Installation File

The Management Pack for NetApp Storage is installed using a .pak file.

5.1.1 Prerequisites• Obtain the Management Pack installation file from http://www.bluemedora.com/true-visibility-suite-

for-vmware/.• Read the release notes that are included with the .pak file.• Back up any out-of-the-box dashboards that have been customized, as they will be overwritten.

5.1.2 Procedure1. Save the .pak file in a temporary location.2. Log in to vRealize Operations as an admin user.3. Click the Home icon, then select the Administration navigation shortcut from the panel on the left.

Figure 1: Home > Administration




4. In the right panel, the Solutions tab will be displayed.

Figure 2: Solutions Tab

5. Click the Add icon ( ) to upload the .pak file to the vRealize Operations server. In the dialog that appears, browse to the location of the saved .pak file, then click Upload.

NOTE: The .pak file upload may take several minutes to complete. Status information appears in the Installation Details text box throughout the installation process.

Figure 3: Select the .pak file to upload


6. Click Next when the upload has finished. Read the End User License Agreement (EULA) and click the ‘I accept the terms of this agreement’ checkbox to accept, then click Next.

7. Click Finish when the installation process is complete.

NOTE: The installation utility creates the netapp_adapter3 folder and netapp_adapter3.jar file in the $VCOPS_BASE/user/plugins/inbound folder. Refer to section “7. Appendix I: Management Pack Folders and Files” for more information.

5.2 Adding a License Key

The Management Pack requires a valid license for full operation. Complete the following steps to license the Management Pack.

1. In vRealize Operations Manager, navigate to Administration > Licensing > License Keys.2. Click the Add icon ( ). In the dialog that appears, select ‘NetApp Storage’.

Figure 4: Add License

3. Enter your Blue Medora license key, then click Validate. If successful, “License key validated successfully” will be displayed.

4. Click Save to finish adding your license key.

NOTE: It may take a couple of minutes to validate your license key. Only click Save once, or it may attempt to add more than one license. If your license key is not validated, please contact Blue Medora Support.


6. Configuring the Management Pack

To configure the Management Pack for NetApp Storage, you must add an adapter instance and credential in vROps. Depending on your configuration, you may also need to perform additional steps.

This section includes the following topics:

NOTE: In this section, an asterisk (*) indicates a topic that applies to DFM servers only.

• Setting Up a Resource Group to Filter Resources* – An optional step that enables filtering of resources imported from the DFM Server by the NetApp adapter instance(s)

• Creating an Adapter Instance and Credential• Configuring the NetApp SLM Server for HTTPS• Configuring the NetApp DFM Server to Collect Metrics* – An optional step to configure the DFM server to

collect metrics if the Auto Filer Configuration option was initially set to False for the adapter instance• Manually Discovering Resources – An optional step to manually discover resources if Auto Discovery was

not selected when adding the adapter instance• Validating Data Collection• Modifying Adapter Instance Properties* – An optional step to customize the operation of an adapter

instance• Disabling or Collapsing Resource Kinds• Disabling Status Events• Filtering Out Unwanted Systems

6.1 Setting Up a Resource Group to Filter Resources*

To filter the resources that a NetApp adapter instance imports from the DFM server, create a resource group and specify the name of that resource group when you define the adapter instance. The adapter instance imports only the resources that belong to the resource group.

NOTE: You can use only one resource group as a filter. The Management Pack does not support filtering resources based on multiple resource groups.

6.1.1 Prerequisites

You must have access to, and knowledge of, NetApp Operations Manager.

6.1.2 Procedure1. Log in to NetApp Operations Manager.

NOTE: NetApp Operations Manager typically runs on port 8080.

2. Select Groups from the Setup drop-down menu.3. Type a name for the new resource group in the text box and click Add. NetApp Operations Manager will

create the resource group.4. Click the link under Group Membership and select the NetApp objects to add to the new resource group.

NOTE: For a newly created resource group, the link is called Empty.

6.1.3 What To Do Next

Specify the resource group when you define the NetApp adapter instance. Refer to section “6.2 Creating an Adapter Instance and Credential”.


6.2 Creating an Adapter Instance and Credential

You must create an adapter instance and credential for the Management Pack in order to define the adapter type and identify the DFM/SLM/API Services server from which the adapter instance will retrieve data.

NOTE: If your environment is configured to support multiple DFM/SLM/API Services servers, you must create an adapter instance for each individual server.

6.2.1 Prerequisites• Install the Management Pack for NetApp Storage. Refer to section “5. Installing the Management

Pack”.• DFM only: To filter the resources the adapter instance imports from the DFM server, create a resource

group. Refer to section “6.1 Setting Up a Resource Group to Filter Resources*” for details.

6.2.2 Procedure1. Log in to vRealize Operations as an administrator.2. Click on the Administration navigation shortcut ( ). The Solutions view should automatically open.3. Select ‘NetApp Storage’ from the Solutions list.

Figure 5: Solutions List


4. Click the Configure icon ( ). The Manage Solution window will appear.

Figure 6: Manage Solution Window

NOTE: If creating multiple adapter instances, click the Add icon ( ) above the list of Instance Names on the left.

5. In the Manage Solution window, enter the following information:

Instance Settings:• Display Name: A name for this particular instance of the Management Pack• Description: Optional; most helpful for describing multiple adapter instances of the Management

Pack


Basic Settings:• API Services or DFM/OCUM Host: Hostname or IP address of target system• Auto Discovery: Default setting is True, which enables the adapter instance to create resources for

you. If you select False, you must manually discover your NetApp Storage resources.• Protocol: Default is HTTPS

NOTE: For DFM/OCUM hosts, you must set the protocol option to HTTP.

NOTE: For HTTPS to connect to SLM hosts, refer to section “6.3 Configuring the NetApp SLM Server for HTTPS”.

• Credential: Click the Add icon ( ), then select the credential type (refer to Figure 7).

Advanced Settings:• Collectors/Groups: Automatically selected• Resource Group For Discovery (DFM/OCUM Only): To limit the resources that the adapter instance

imports to the resources that belong to a particular DFM server resource group, type the name of the resource group. Use a forward slash (/) to specify nested resource groups. For example, if the DFM server resource group is Global > TestGroup1 > TestGroup2, type TestGroup1/TestGroup2.

• Auto Filer Configuration (DFM/OCUM Only): With the default setting of True, the adapter instance configures the DFM server to collect metrics that vROps needs for analysis (though it has no effect on clustered environments). Refer to section “6.4 Configuring the NetApp DFM Server to Collect Metrics*”, to enable metric collection for a clustered environment. If you select False, you must configure the DFM server from the NetApp Management Console. Because the auto filer configuration acts directly on the DFM settings, the option that you select affects all adapter instances for this DFM server.

• Port: The default setting is 0, which uses the default port for the server• Disk Collection: Select the option you want to enable/disable for disk collection: Collapse, Metadata,

Metadata and Performance data, or Off. If using API Services in direct-attached mode, select Metadata and Performance data. (Direct-attached mode does not generate events/alerts in the usual manner. Indirect-attached mode systems receive events from OCUM, which is no longer used in direct-attached mode.)

• Network Port Collection: Select the option you want to enable/disable for network port collection: Collapse, Metadata, Metadata and Performance data, or Off.

• Fibre Channel Port Collection: Select the option you want to enable/disable for fibre channel port collection: Collapse, Metadata, Metadata and Performance data, or Off.

WARNING: Enabling the collection of Performance data in large NetApp environments may significantly impact the performance of your DFM/SLM/API Services server and vROps environments.

• Disable Status Events: The default setting is True. If using API Services in direct-attached mode, select False to enable status events. (Direct-attached mode does not generate events/alerts in the usual manner. Indirect-attached mode systems receive events from OCUM, which is no longer used in direct-attached mode.)

• Systems To Filter Out: List any systems here that you do not want included in data collection. These systems will be excluded, along with their child resources.


Figure 7: Manage Credential

• Credential Kind: NetApp Adapter Credentials• Credential Name: A name for this set of Management Pack credentials• User Name: User Name for your NetApp storage system• Password: Password for your NetApp storage system

NOTE: The vRealize user name/password fields are shown only when the deprecated credential kind is selected. They are maintained for backward compatibility purposes only and are not necessary for proper operation.

6. Click OK to save your credential.7. Click Test Connection to ensure vRealize Operations can connect properly to the system.8. Click Save Settings to save your adapter instance configuration.


If you set the Auto Filer Configuration option to False, next, you must configure the DFM server to collect metrics. Refer to section “6.4 Configuring the NetApp DFM Server to Collect Metrics*”.

If you set the Auto Filer Configuration option to True, you might want to modify the events and metrics that the adapter instance collects. Refer to “6.7 Modifying Adapter Instance Properties*”.

If you set the Auto Discovery option to False, you will have to go back and manually discover NetApp resources. Refer to section “6.5 Manually Discovering Resources”.


6.3 Configuring the NetApp SLM Server for HTTPS

If your SLM server uses the HTTPS protocol, you must edit the versions of TLS that JBoss will allow.

6.3.1 Procedure1. Edit the /opt/netapp/essentials/jboss/standalone/configuration/standalone-full.

xml file on the SLM server.2. Look for the line containing enabled-protocols.3. Add TLS v1, before TLS v1.1, TLS v1.2.


6.4 Configuring the NetApp DFM Server to Collect Metrics*

If you set the Auto Filer Configuration option to False for a NetApp adapter instance, you must configure the DFM server to collect the metrics that vROps needs for analysis. Due to a NetApp restriction, Auto Filer Configuration is not possible for clustered environments. Enabling Auto Filer Configuration in a clustered environment will have no effect.

If you have a NetApp DFM server, configure the DFM server to collect metrics by enabling counters for the NetApp Filers. You must enable the counters for all of the NetApp Filers on the DFM server. You can enable the counters for each NetApp Filer individually, or you can configure one NetApp Filer and apply its settings to the remaining NetApp Filers.

NOTE: You must also perform these steps if a NetApp Filer is added to the DFM server. If you do not configure the new NetApp Filer, the vROps adapter performs analysis based on only a partial list of counters.

6.4.1 Procedure1. Log in to NetApp Management Console as Administrator.2. Type in the DFM server information.3. Select Task > Manage Performance.4. Click Setup.5. Click Host and select the first host in the host list.6. Select Data Collection > Edit.7. A configuration wizard appears and lists the disabled and enabled counters for the NetApp Filer.8. Move counters from the Disabled Counters list to the Enabled Counters list to enable them.

Table 3: Group Descriptions

GROUP DESCRIPTION

CIFS cifs_latency, cifs_ops, cifs_read_ops, cifs_write_ops

FCP fcp_ops, fcp_read_data, fcp_write_data, fcp_latency

ISCSI iscsi_latency, iscsi_ops, iscsi_read_data, iscsi_write_data

LUN avg_latency, other_ops, read_data, read_ops, total_ops, write_data, write_ops, queue_full

NFSv3 nfsv3_ops, nfsv3_read_latency, nfsv3_read_ops, nsv3_write_latency, nfsv3_write_ops

PriorityQueue max_user_read_ms, avg_sys_pending_ms, avg_usr_pending_ms, max_sys_reads

System cifs_ops, fcp_ops, avg_processor_busy, cpu_busy, disk_data_read, disk_data_written, net_data_recv, net_data_sent, totalprocessor_busy, read_ops, write_ops

vFiler vfiler_cpu_busy, vfiler_misc_ops, vfiler_net_data_recv, vfiler_data_sent, vfiler_read_bytes, vfiler_read_ops, vfiler_write_bytes, vfiler_write_ops

Volumeavg_latency, cifs_other_latency, cifs_other_ops, cifs_read_data, cifs_read_latency, cifs_read_ops, cifs_write_data, cifs_write_latency, cifs_write_ops, nfs_other_latency, nfs_other_ops, nft_read_data, read_data, read_latency, read_ops, total_ops, write_data, write_ops

9. Click Finish. (Optional: To copy and apply the configuration of the NetApp Filer to another NetApp Filer, select the NetApp Filer and select Data Collection > Copy.)


6.5 Manually Discovering Resources

With manual discovery, the Management Pack for NetApp Storage sends a request to the DFM/SLM/API Services server to return resources and you select the resources to import into vROps. The discovery mode that you configure determines whether the Management Pack imports only the selected resource, or the selected resource and all of its child resources.

With Basic Discovery mode, the Management Pack discovers all resources unless you specify a particular resource kind. It imports only the resources that you select. With Hierarchical Discovery mode, the Management Pack discovers only NetApp systems. After the first collection cycle, it imports all child objects for the NetApp systems that you import.

The Retrieve Full Hierarchy resource identifier is enabled for resources imported in Hierarchical Discovery mode. For resources imported in Basic Discovery mode, the Retrieve Full Hierarchy resource identifier is disabled.

NOTE: When you use Auto Discovery, the Retrieve Full Hierarchy resource identifier is disabled by default.

After the Management Pack imports a NetApp system in one discovery mode, it cannot rediscover the same NetApp system in another discovery mode. However, you can change the discovery behavior for a specific NetApp system by editing the resource for the NetApp system and selecting a different value from the Retrieve Full Hierarchy drop-down menu. For information about editing resources, see the vROps UI online help.

6.5.1 Prerequisites

Create a NetApp Storage adapter instance and credential. Refer to section “6.2 Creating an Adapter Instance and Credential”, for details.

6.5.2 Procedure1. Log in to vRealize Operations as an administrator.2. Click the Administration navigation shortcut ( ).3. Click Inventory Explorer in the navigator pane.

Figure 8: Inventory Explorer > Adapter Types

4. Under Adapter Types, select ‘NetApp Adapter’.


5. Click the Discover Resources icon ( ) to open the Discover Objects window.

Figure 9: Discover Objects Window

6. In the Discover Objects window, select the following information:• The Collector to use

NOTE: Unless you added additional collectors, the only available collector is your vROps server.

• ‘NetApp Adapter’ for Adapter Type• The applicable Adapter Instance• ‘Basic Discovery’ or ‘Hierarchical Discovery’ for Discovery Info:

Table 4: Discovery Options

OPTION DESCRIPTION

Basic Discovery Discovers all resources, or only the specified resource kind, based on the Resource Kinds drop-down menu selection.

Hierarchical Discovery Discovers only NetApp systems. After the first collection cycle, the adapter imports all child objects for the NetApp systems that you import.

• Whether Only New Objects (select/de-select checkbox) should be collected

7. Click OK to start the discovery process.8. The discovery process can take several seconds to several minutes. When it has finished, the Discovery

Results window lists your resources.


9. Double-click each resource kind that contains resources to add.

NOTE: The resource list shows all of the resources of the specified resource kind. You can sort the resource list by clicking any column header. To find a specific resource in the list, type all or part of the resource name in the Search text box and click Search.

10. Select options for each kind of resource. The resource options are described below.

Table 5: Resource Options

OPTION DESCRIPTION

Import Import the resources but do not start collecting data. Resources appear in the resource list as Not Collecting; data is not stored; analysis is not performed.

Collect Import the resources and start collecting data. When you select the Collect check box, the Import check box is also selected.

Attribute Package To use a non-default attribute package for a resource, select an attribute package from the drop-down menu or click Add to define a new attribute package.

11. Click OK. The Discovery Results window closes and the new resources appear.


If you did not select the option to start metric collection when you defined a resource, you can start metric collection after the resource is defined. To start collecting metrics for a resource, choose the resources, then click the Start Collecting icon ( ).

6.6 Validating Data Collection

After you add a NetApp Storage adapter instance, you will want to validate the data that it collects in vRealize Operations.

6.6.1 Prerequisites

Add a NetApp Storage adapter instance. Refer to section “6.2 Creating an Adapter Instance and Credential”, for details.

6.6.2 Procedure1. Check the Environment Overview page for NetApp resources. If you enabled Auto Discovery for the

adapter instance, it will create resources as soon as it begins collecting metrics. If you disabled Auto Discovery for the adapter instance, you must go back and discover resources manually before you can validate data collection. Refer to section “6.5 Manually Discovering Resources”.

2. Check the Health Tree for NetApp resource relationships. The adapter instance creates a resource relationship when the parent and child resource exist in vROps. The adapter instance creates resource relationships during manual discovery.

3. View the Metric Graph to compare values to the data source. The NetApp adapter instance creates metrics during data collection.


6.7 Modifying Adapter Instance Properties*

Management Pack operation can be customized by modifying an adapter instance’s properties in the netapp.properties file located in the $VCOPS_BASE/user/plugins/inbound/netapp_adapter3/conf/ folder. You must restart the collector service after modifying the netapp.properties file in order for your changes to take effect.

When you set the Auto Filer Configuration option to True for a NetApp adapter instance, the properties in the netapp.properties file determine which events and metrics the adapter instance collects. You can change the events and metrics that the DFM server collects by modifying these properties. You can also change the mapping of metrics the DFM server returns to the NetApp adapter instance by modifying the metricmapping.xml file.

NOTE: Properties marked with an asterisk (*) in the table below are related to QoS policies, which are not applicable for 7-mode systems.

Table 6: netapp.properties File Properties

PROPERTY DESCRIPTION

retrieveSelectedResources Boolean value that determines how the adapter requests performance data from the DFM server during a collection cycle. If you set this property to True, the adapter discovers and imports performance data only of the filers imported in the adapter imports performance data for all DFM resources.If your DFM environment includes a large number of filers, you might want to set this property to True to improve performance.

Events List of event types to collect and display.For a compete list of events supported by your DFM version, log into the DFM server and run the command dfm eventType list.

EventSeverities A list of event severity levels to retrieve from the DFM.

CollectHistoricDataEnabled Boolean value that determines whether the adapter collects historic data.

HistoricDataToCollectInHours Number of hours of historic data before the current time that the adapter collects.

HistoricDataChunkCollectionInHours Number of hours of historic data that the adapter collects for each collection.

RelationshipSyncIntervals When RelationshipSyncFlag is set to True, it determines the number of collection cycles that must occur before the adapter synchronizes relationships.For example, a value of 10 causes the adapter to synchronize relationships after 10 collection cycles. For more information, refer to section “6.4 Configuring the NetApp DFM Server to Collect Metrics*”.

RelationshipSyncFlag Determines whether VMware Datastore relationships will be enabled.

EnableQosCollection* Determines whether the adapter will collect QoS policies and metrics.

QosSyncInterval* Determines how many collection cycles must occur before the adapter attempts to update the QoS policies for LUNs, Volumes, and Storage Virtual Machines. NOTE: QoS usage metrics (e.g., “qos|iops_usage_percentage”) are computed on every collection.

ParallelCollectionEnabled Determines whether performance data requests will be broken up into multiple, parallel-running API calls.

MaximumNumberOfEventsToCollect Determines the maximum number of events the adapter will collect per collection cycle.


PROPERTY DESCRIPTION

MaximumRelationshipsReported PerCollection

Determines the maximum number of relationships the adapter will report per collection cycle.

CifsDefaultMetrics List of metrics that belong to the CIFS group.

FcpDefaultMetrics List of metrics that belong to the FCP group.

IscsiDefaultMetrics List of metrics that belong to the iSCSI group.

LunDefaultMetrics List of metrics that belong to the LUN group.

Nfsv3DefaultMetrics List of metrics that belong to the NFSv3 group.

PriorityQueueDefaultMetrics List of metrics that belong to the priority queue group.

SystemDefaultMetrics List of metrics that belong to the system group.

VFilerDefaultMetrics List of metrics that belong to the vFiler group.

VolumeDefaultMetrics List of metrics that belong to the volume group.

PathStringCharacterLimit Maximum character limit of a path string, A path string is the absolute path to a specific NetApp Volume or LUN.Because a filer can have multiple IP addresses, the path string is created by concatenating the paths for each IP address and filer name. For example, for a volume named vol1 on a filer named filer1 the path string might be |/filer1/vol/vol1/|/filer1_IP_ADDRESS/vol/vol1|/filer1_IP_ADDRESS/vol/vol1/.If a path string exceeds the character limit set by this property, the adapter trims the path string and relationships are not created in vROps. If this problem occurs, modify the database schema to allow the identifier to have more characters and set this property to the new limit.

CollectionInterval Advanced control; designed for large NetApp environments where performance is a proven concern. The OnCommand Unified Manager (DFM) organizes performance counters into Object Types (Aggregate, Disk, System, etc.). Each time the Management Pack requests data from DFM, it specifies an Object Type and a time window.This property allows you to control the collection frequency for each Object Type. If set to 0 (the default), the adapter instance resource’s collection interval is used.This property only affects live data collection (does not apply to historical data collection cycles).

CollectionWindow Advanced control; designed for large NetApp environments where performance is a proven concern. The OnCommand Unified Manager (DFM) organizes performance counters into Object Types (Aggregate, Disk, System, etc.). Each time the NetApp Management Pack requests data from DFM, it specifies an Object Type and a time window.This property allows you to control the size of the time window (in minutes) for each object type. If set to 0 (the default), the object type’s collection window size will be set to twice the collection interval.This property only affects live data collection (does not apply to historical data collection cycles).

CollectType Advanced Control; describes whether to collapse data to the nearest parent object, collect Metadata, Metadata and Performance data, or no data (Off) for each object type. NOTE: The string literals must be matched exactly. Collecting just Performance data without Metadata is not allowed, as Metadata is required to discover the object.


6.8 Disabling or Collapsing Resource Kinds

Certain resource kinds can be disabled or collapsed into parent resource kinds. This can be done by modifying the netapp.properties file in the $VCOPS_BASE/user/plugins/inbound/netapp_adapter3/conf/ folder. You can tune adapter operation by modifying the properties in the file and saving it. The modified properties will be read in during the next collection.

Historical data from resources previous to collapse will not be moved to the new collapsed resource. If a resource is uncollapsed, the data retrieved while the resource was collapsed will not move to the uncollapsed resource. The historical data of the collapsed resource will remain on the parent object.

##### Object Type Collection Types## Description:# Describe whether to collect Metadata, Metadata and Performance Data, or no data for each object type.# - If set to ‘Metadata and Performance data’, all data will be collected for objects of that type.# - If set to ‘Metadata’, performance data for that object type is not collected.# - If set to ‘Off’, no data will be collected for this object type.## Note: the string literals must be matched exactly. Collecting just Performance data without Metadata is# not allowed since Metadata is required to discover the object.#####AggregateCollectType=Metadata and Performance dataVolumeCollectType=Metadata and Performance dataVServerCollectType=Metadata and Performance dataVFilerCollectType=Metadata and Performance dataSystemCollectType=Metadata and Performance dataClusterCollectType=Metadata and Performance data

##### Collapsible Object Types## Description:# In addition to ‘Metadata’, ‘Metadata and Performance Data’, and ‘Off’, the following may also be set to ‘Collapse’.# - If set to ‘Collapse’, all collected data will be attached to the nearest collected parent object.####LunCollectType=Metadata and Performance dataLunVvolCollectType=Metadata and Performance dataQTreeCollectType=Metadata and Performance dataSnapMirrorCollectType=Metadata and Performance data


6.9 Disabling Status Events

The default for this setting is True. Only set this to False if using API Services 1.2 in direct-attached mode. You must also set Disk Collection to Metadata and Performance data.

Direct-attached mode does not generate events/alerts in the usual manner. Non direct-attached mode systems receive events from OCUM, which is no longer used in direct-attached mode.

6.10 Filtering Out Unwanted Systems

You can enter a comma-separated list of systems to filter out (blacklist) so that data will not be collected. These systems will be removed along with their children.

NOTE: Systems filtered out (blacklisted) will not be counted toward licensing.


7. Appendix I: Management Pack Folders and Files

The installer places the Management Pack files in the netapp_adapter3 folder under the $VCOPS_BASE/user/plugins/inbound folder as shown below.

Table 7: Management Pack Folders and Files

FOLDER FILE DESCRIPTION

conf alerts.yml Describes alerts provided by this Management Pack

api_services_collections.yml

capacity.yml Describes capacity metrics provided by this Management Pack

dashboards (folder) Contains .json files for Management Pack dashboards

describe.xml Describes the Management Pack

describe.yml Describes the Management Pack

describeSchema.xsd Used to validate describe.xml

historical.properties Used to enable historical mode. Allows the adapter to backfill data if collection is interrupted for any reason.

images (folder) Contains .png files for AdapterKind, ResourceKind, and TraversalSpec

license.properties Contains back-up copy of licenses used for this Management Pack

metric_definitions.yml

metricmapping.xml Describes the mapping of metrics a DFM server returns to the adapter instance

netapp.properties Contains properties that can be modified to adjust adapter operation

NOTICE.txt File required when using an OSS project under the Apache License V2.0

open_source_license.txt Open source license file

oss_attribution.txt Describes open source libraries used by the Management Pack

policy.yml Describes the capacity policies used by the Management Pack

reports (folder) Contains .xml files for Management Pack reports

reskndmetrics (folder) Contains .xml files for Dashboard Metric configuration

resource_definitions.yml

resources (folder) Contains resources.properties file

rollup_metrics.yml

scripts (folder) Contains .sdm files consumed by the Management Pack

traversal.yml Describes the traversal specs for this Management Pack

version.txt Contains version information

views (folder) Contains .xml files for Management Pack views

lib Refer to lib folder for entire list .jar files that contain the classes and resources used to implement the Management Pack

work install.log

lastcollection_#.properties Tracks when the last collection for each adapter instance was performed (used when historic mode is enabled)


8. Appendix II: Revision Notes

This installation guide is updated with each release of the product, or when necessary. The following table provides its revision history.

REVISION DATE DESCRIPTION

REV-22 31-MAR-2017

• Updated “Table 1: Management Pack Installation & Configuration Requirements” to add support for SLM

• Updated section “4. Upgrading the Management Pack” to include information about backing up the properties file

• Added sections “6.3 Configuring the NetApp SLM Server for HTTPS” and “6.8 Disabling or Collapsing Resource Kinds”

• Removed Management Pack Properties Files section• Updated section “7. Appendix I: Management Pack Folders and Files” to show

current Management Pack files

REV-21 30-DEC-2016

• Removed vRealize Operations credential requirement from Table 1: System Requirements

• Added support for NetApp API Services 2.0 to Table 1: System Requirements• Added Advanced Settings for Network Port and Fibre Channel Port Collection

(replaced Manage Solution window)• Replaced Manage Credential window (no longer requires vROps credentials)• Updated section “4. Upgrading the Management Pack”

REV-20 26-SEP-2016• Updated section “3. Licensing Requirements” to include support for True

Visibility Suite licensing• Removed Suite API requirement from vROps credentials in Table 1

REV-19 12-SEP-2016

• Updated name of Section 1 to Purpose and removed Section 1.1, Intended Audiences

• Moved Revision Notes to Appendix II• Updated Table 1 to remove + signs from NetApp API Services names• Updated Section 5.1.1, Prerequisites with latest release number• Add Note for LUN VOLs to Section 5, Installing the Management Pack

REV-18 17-JUN-2016

• Updated Section 4, Licensing Requirements• Updated most figures• Added to 6.1.1, Prerequisites• Updated 7.8, Management Pack Properties Files• Added 7.9, Disable Status Events and 7.10, Filtering out Unwanted Systems

REV-17 06-JAN-2016

• Updated section 3. Installation and Configuration Requirements to include support for OnCommand Unified Manager (OCUM) 6.3 and reformatted into tabular format

• Added/fixed cross-references throughout document

REV-16 08-JUN-2015

• Clarified Adapter Instance Credential Requirements in Section 3.4 (removed section 3.5)

• Added section 5. Upgrading the Management Pack, which describes how to remove NetApp dashboards when upgrading to a newer version

REV-15 22-MAY-2015• Migrated to new format• Updated for API services

REV-14• Added QosSyncInterval and QosCollectionEnabled to netapp.properties section• Added permissions requirements regarding QoS policy retrieval



REV-13

• Changed table that described dashboards into a separate section that includes descriptions, widget interactions and screenshots

• Added view table that describes views included in the management pack in Understanding NetApp Management Pack Views

• Added icons to the metric information section• Added Alerts section that lists all alerts generated by the management pack in

NetApp Alerts• Added inventory tree graphics

REV-12

• Updated verbiage to reflect changes between vCenter Operations Manager 5.x and vRealize Operation 6.0

• Updated adapter configuration changes made to NetAppAdapter Instance resource kind

REV-11

• Updated documentation for vRealize Operations Management Pack for NetApp version 4.0 release.

• Added out-of-the-box dashboards in Understanding the NetApp Management Pack Dashboards section

• Added Entity Status Resource Tags in NetApp Entity Status Tags section• Discontinued support for DFM versions prior to 5.x.

REV-10 • Added Licensing the Management Pack section

REV-09

• Added support for NetApp OnCommand Unified Manager Core (DFM) Server 5.2 in NetApp OnCommand Unified Manager Core (DFM) Server Compatibility

• Added a note that you must have the Global Full Control role in order to create relationships between VMware Datastores and NetApp LUNs in Creating Relationships Between Datastores and NetApp LUNs or Volumes

• Added descriptions for the metricmapping.xml and metricmapping_3_8.xml files in NetApp Adapter Folders and Files

• Added a clarification regarding the use of the metricmapping.xml in Modifying Adapter Properties

REV-08

• Added support for NetApp OnCommand Unified Manager Core (DFM) Server 5.1 in NetApp OnCommand Unified Manager Core (DFM) Server Compatibility

• Added support for relationships between VMFS datastores and NetApp LUNs in Creating Relationships Between Datastores and NetApp LUNs or Volumes

REV-07 • Updated the library files listed in NetApp Adapter Folders and Files section

REV-06

• Added information about specifying nested NetApp OnCommand Unified Manager Core (DFM) resource groups to Add an Adapter Instance section

• Described how to manually discover NetApp resources and select a manual discovery mode in Manually Discover NetApp Resources section

REV-05 • Added a note about NFS datastore support to Creating Relationships Between Datastores and NetApp LUNs or Volumes section

REV-04• Added NetApp Adapter Folders and Files section• Added Using the Relationship Synchronization Feature section

REV-03 • Added Modifying Adapter Properties section

REV-02 • Added troubleshooting information in Resolving Common Problems section.

REV-01

• Added information about configuring the protocol and port to use to connect to the NetApp OnCommand Unified Manager Core (DFM) server to the Add an Adapter Instance section.

• Added Set Up a Resource Group to Filter Resources section.



REV-00• The NetApp Adapter Technical Note is now the NetApp Adapter Installation and

Configuration Guide. (Note: The NetApp Adapter Technical Note was the initial release of this document.)

Copyright © 2017 Blue Medora Inc. All rights reserved. U.S. and international copyright and intellectual property laws protect this product. Blue Medora is a registered trademark or trademark of Blue Medora in the United States and/or other jurisdictions.

The NetApp name (including NetApp Storage and NetApp OnCommand Unified Manager) and logo are trademarks or registered trademarks of NetApp, Inc. in the United States and/or other jurisdictions. All other marks and names mentioned herein may be trademarks of their respective companies.

Blue Medora3225 N Evergreen Dr. NE Suite 103Grand Rapids, MI 49525

bluemedora.com

You can find the most up-to-date technical documentation on the Blue Medora support site at: http://support.bluemedora.com.

The Blue Medora website also provides the latest product updates. If you have comments about this documentation, submit your feedback to: [email protected].

http://bluemedora.com

http://support.bluemedora.com

mailto:support%40bluemedora.com?subject=

Date post:	08-Mar-2018
Category:	Documents
Upload:	truongnga
View:	228 times
Download:	2 times

Installation & Configuration Guide - Blue Medora · PDF file4 Blue Medora VMware vRealize...

Documents