onecollect 1.5 installation and setup...

OneCollect 1.5

Installation and Setup Guide

August 2018 | [email protected]

Contents

Overview of OneCollect ............................................................................... 5Installing and setting up OneCollect .......................................................... 6

System requirements for OneCollect .......................................................................... 6

Supported device types and protocols for data collection ........................................... 7

Installing OneCollect Docker Image ......................................................................... 10

Installing OneCollect on Windows using the installation wizard ............................. 11

Installing OneCollect on Windows using software archive ...................................... 12

Installing OneCollect on Mac OS X ......................................................................... 13

Installing OneCollect on Linux ................................................................................. 14

Editing data collection preferences ........................................................................... 15

Hosting OneCollect with nginx (HTTPS) ................................................. 16Creating user accounts .............................................................................................. 16

Replacing nginx.conf file .......................................................................................... 17

Running OneCollect with nginx on Mac and Linux hosts ........................................ 18

Deploying a OneCollect Amazon Machine Image ................................... 19Deploying a OneCollect AMI ................................................................................... 19

Accessing the OneCollect Amazon Machine Image ................................................. 20

Upgrading OneCollect ............................................................................... 21Collecting and uploading data from devices using OneCollect .............. 22

Collecting data using OneCollect .............................................................................. 22

Collecting data using the device-based collection method ........................... 23

Collecting data using the solution-based collection method ......................... 24

Collecting data using Serial port ................................................................... 25

Collecting data using AutoSupport method .................................................. 25

Collecting data using OneCollect's Host Performance Plug-In .................... 27

Collecting data using SnapCenter Plug-in .................................................... 28

Uploading Host Performance data files to AutoSupport ............................... 29

Discovering devices automatically and collecting data ................................. 30

Scheduling a data collection job ................................................................................ 31

Editing a saved job .................................................................................................... 32

Viewing collected data .............................................................................................. 33

Understanding IMT Advisor ......................................................................... 34

Collecting and uploading data to AutoSupport ......................................................... 35

Uninstalling OneCollect ............................................................................. 37Uninstalling OneCollect from a Windows host ......................................................... 37

Uninstalling OneCollect from the Mac and Linux hosts ........................................... 37

Troubleshooting .......................................................................................... 39Resolving OneCollect launching error ...................................................................... 39

Backing up the database ............................................................................................ 40

Changing the default timeout for command execution ............................................. 40

Restarting the OneCollect server ............................................................................... 40

Table of Contents | 3

Sending the feedback ................................................................................................ 41

Searching for the result and log files ......................................................................... 41

Copyright information ............................................................................... 43Trademark information ............................................................................. 44How to send comments about documentation and receive update

notifications ............................................................................................ 45Index ............................................................................................................. 46

4 |

Overview of OneCollect

OneCollect is a data collection tool. In addition to collecting data from storage area network (SAN),it collects data from network-attached storage (NAS) environments. The diagnostic content related toyour environment can be either sent to NetApp for further analysis or analyzed on premises.

You can use OneCollect to collect data from storage systems, hosts, and switches. You can alsoextend the profiles available in the OneCollect tool to collect data from new types of systems. Youcan send the collected data back to NetApp for better support and assessment of operations, such asnondisruptive upgrades and data migration. OneCollect supports data collection through multipledata collection protocols. OneCollect posts the data that is collected to AutoSupport.

For more information about Solution-based and Device-based collection types, see Supported devicetypes and protocols for data collection. on page 7

Solution-based collection profile and device-based collection profile are two types of data collectionprofiles. Solution-based collection profile is a predefined environment. Device-based collectionprofile allows the user to create their own environment.

OneCollect compiles data about all the host operating systems, switches, storage arrays and otherdevices, which comprise most systems found in a typical enterprise ecosystem. Typical systemsinclude Windows, Linux, VMware, FreeBSD, Solaris, AIX, HP-UX, Cisco IOS/NXOS/SANOS/UCS, Brocade, NetApp ONTAP, E-Series, and others. You can view the raw data from eachcollection. OneCollect uses native administrative methods, including SSH, HTTPS, and WMIprotocols to communicate with systems and devices

To perform data collection against remote hosts, it is necessary that you provide administrativecredentials. If you decide to store credentials, OneCollect provides password-protected encryption(pass phrase) to keep your credentials confidential. The credentials are stored in a database andencrypted using Advanced Encryption Standard (AES).

As you start using OneCollect, it is important that you understand some of the basic terms that youcan expect to see throughout the OneCollect user interface.

Persona Description

General Collects basic commands for the target device

Diagnostic Collects additional diagnostic commands andlogs from the device other than the ones that runin General mode

SnapDrive Collects SnapDrive specific diagnostic logs

SnapManager Collects SnapManager specific logs

SnapManager for Oracle (SMO) Collects SnapManager for Oracle specific logs

SnapManager for SAP (SMSAP) Collects SnapManager for SAP specific logs

Orchestrator Runs commands or collects logs related toVMware orchestrator

Note: For generating report or parsing in the Unified Parser, NetApp recommends usingDiagnostic persona in OneCollect to collect all the required commands and logs.

5

Installing and setting up OneCollect

Before you can start collecting data using OneCollect, you must download and install OneCollect.After installing, you can add a plug-in to extend the data collection capabilities of the tool.

System requirements for OneCollectYou must ensure that you have the required host system configuration, operating system, browser,and ports to run OneCollect.

OneCollect can run on the following operating systems:

• Windows 7 (64-bit)



• Windows 2008 R2 Server (64-bit)

• Windows 2012 R2 Server (64-bit)

• Mac OS X 10.10 and later (64-bit)

• Red Hat Enterprise Linux (RHEL) 6.3 and later (64-bit)

• Ubuntu 7.0 and later (64-bit)

OneCollect supports the following browsers:

• Mozilla FireFox 55 and later

• Google Chrome 61 and later

• Apple Safari 11 and later

• Microsoft Edge 40 and later

OneCollect uses the following configurable ports for launching by default.

• HTTP(8044)

• HTTPS(7443)

On target systems, to connect, OneCollect uses the native protocols of the system, such as SSH,HTTP, HTTPS API, WMI, and others. Following are default ports for these services:

• SSH(22)

• HTTP(80)

• HTTPS(443)

• WMI(135 and 445)

The system (virtual machine or a physical server or a laptop) on which OneCollect is installed musthave a minimum of 2 GB RAM and 2 cores. You can increase the capacity and accordinglyOneCollect can scale multiple processes in the case of large data collection.

6

Supported device types and protocols for data collectionOneCollect supports profiles that help you in collecting data from devices and solutions. You shouldlearn more about these profiles to help you decide which one to use.

Each profile contains the credentials for the database associated with the profile. The credentialsenable OneCollect to connect to and work with the database. The stored credentials include the username and password for accessing the host, the repository, the database, and the required information.

Device-based collection types

Type Sub type Supported persona Supported protocol

Cloud Services AltaVault General and Diagnostic

Hybrid switch Cisco Nexus5000/6000/9000 series

General and Diagnostic SSH

Hybrid switch Cisco Nexus 7000series

General and Diagnostic SSH

Ethernet switch Cisco General and Diagnostic SSH

Ethernet switch NetApp General and Diagnostic Shell and SSH

Ethernet switch Brocade General and Diagnostic SSH

Ethernet switch Cisco Catalyst General and Diagnostic SSH

Fibre Channel(FC) switch

Cisco General and Diagnostic SSH

FC switch Brocade Diagnostic SSH

FC switch QLogic Diagnostic SSH

FC switch McData Diagnostic SSH

FC switch McData i10k Diagnostic SSH

Host Cisco UCS General UCSM XML API

Host vCenter Server General and Diagnostic vCenter Web API

Host Linux (RedHatEnterprise and SuSe)

General, Diagnostic,SnapDrive, SMO, SMSAP,and Orchestrator

SSH

Host Solaris General, Diagnostic, SMO,SnapDrive, and SMSAP

SSH

Host HPUX General, Diagnostic, SMO,SnapDrive, and SMSAP

SSH

Host PowerVM General SSH

Host ESXi General and Diagnostic SSH

Host Windows Diagnostic, DMR, andSnapManager

WMI

Host AIX General, Diagnostic, SMO,SnapDrive, and SMSAP

SSH

Host KVM General SSH

Installing and setting up OneCollect | 7

Host Oracle VM Manager General and Diagnostic SSH

Host Citrix XenServer General and Diagnostic SSH

Host Oracle VM Server General and Diagnostic SSH

StorageController

Data ONTAP 7-Mode General and Diagnostic ONTAPI, HTTPS, andSSH

StorageController

ONTAP General, Dblade, andDiagnostic

ONTAPI, HTTPS, andSSH

StorageController

SolidFire General SolidFire Element OSAPI

StorageController

E-Series-SMCli General SMCli

StorageController

E-Series-WebServicesProxy

General E-Series WebServicesAPI

StorageController

Service Processor-ONTAP

Diagnostic SSH

StorageController

Service Processor-7-Mode

Diagnostic SSH

SnapCenter SnapCenter API General SnapCenter API

Other StorageController

InsightIQ InsightIQ_Perf SSH

Other StorageController

Isilon OneFS8_General,OneFS8_Perf_Sample,OneFS7_General, andOneFS7_Perf_Sample

SSH

Solution-based collection types

Profile Sub profile Corresponding device Supported protocol

ONTAP Plug-in Network • Cluster Node

• Cluster Switch

• Management Switch

• HTTPS and SSH

• SSH

• SSH

FlexPod Plug-in FlexPod-ONTAP • Cisco UCS Cluster

• Cluster Node

• Cluster Switch

• Nexus Switch

• vCenter Server(vCenter)

• UCSM XML API

• HTTPS and SSH

• SSH

• SSH

• HTTP API

FlexPod Plug-in FlexPod-7-Mode • Cisco UCS Cluster

• Storage Controller

• Nexus Switch

• UCSM XML API

• HTTPS and SSH

• SSH

8 |

FlexPod Plug-in FlexPod-SolidFire • Cisco UCS Cluster

• SolidFire Cluster

• Nexus switch

• UCSM XML API

• SolidFire ElementOS API

• SSH

ONTAP 7 ModePlug-in

Network • Storage Controller • HTTPS

• SSH

NetApp-HCI Plug-in Network • ONTAP Select

• SolidFire cluster

• vCenter Server

• SSH and HTTPS

• SolidFire API

• vCenter API

MetroCluster Plug-in

All MetroClusterconfigurations

• Cluster Node/Simulation Node

• Fabric switch

• ATTO bridges

• SSH, HTTPS, andTelnet

• SSH

• Telnet

FlexArray Plug-in • Direct Attached

• Fabric Attached

• Cluster Node

• Back-end FC switch(Cisco and Brocade)

• HTTPS and SSH

• SSH and Telnet

E-Series Plug-in • Host

• SMCli

• NetAppSANtricity WebServices Proxy

• Host

• SMCli

• Web Services Proxy

• SSH

• SMCli

• Web Services API

SnapCenter Plug-in • Configuration

• SnapCenterServer Post-Install

• SnapCenterServer Pre-Install

• SnapCenter Server

• ONTAP cluster

• ONTAP SVM

• Windows hosts

• Linux hosts

• vCenter

• SnapCenter API

• SSH

• WMI


Installing OneCollect Docker ImageOneCollect image is available using Ubuntu 14.04 as a collection of Docker containers. It helps inlaunching OneCollect on any operating system as long as Docker is installed on your system.OneCollect installs and runs consistently across platforms because the environment is containerized.

Before you begin

You must install Docker before you install OneCollect.

Note: The steps given below are for installing docker image on Amazon EC2 instance as anexample.

About this task

You can install the image on any lab system or laptop by installing Docker and running the commandprovided below.

docker run -d -p 80:80 -p 443:443 netapp/onecollect /NetApp/launch

Steps

1. Log in to the "Amazon Web Services" console.

The EC2 Dashboard is displayed.

2. Search AWS Marketplace for OneCollect.

3. Enter your AWS credentials to sign in to your account.

4. Click Sign In.

5. Click Launch Instance.

6. On the Choose an Amazon Machine Image page, click the Ubuntu instance.

7. On the Choose an Instance Type page, either retain the default selection or select the instance typebased on your requirement. Click Next: Configure Instance Details.

8. Select the options from the Network and Subnet drop-down lists.

9. In the Network Interfaces pane, copy the following launching instructions and paste it in to thetext box.

#!/bin/bashapt-get updateapt -y install docker.iodocker run -d -p 80:80 -p 443:443 netapp/onecollect /NetApp/launch

10. Click Add: Add Storage.

11. Click Add: Add Tags.

12. Type the tags in the Key and Value fields.

13. Choose a Security Group for the OneCollect instance.

The security group describes which ports and IP addresses the OneCollect uses to communicatewith other virtual machines (VMs).

10 |

https://www.docker.com/get-docker

14. Review the Assign a security group option buttons and select one option if OneCollect needs thesecurity policy to allow HTTP and HTTPS protocols for connection. You can also assign the SSHpolicy for logging into the instance for troubleshooting.

15. Click Review and Launch.

16. Click Launch.

17. If you have not created a key pair, from the Select an existing key pair or Create a new key pairpage, select an existing key pair. Otherwise, select the already created key pair name.

18. Click "Download Key Pair".

19. Click Launch Instances.

After you have completed the process successfully, your instances start launching. Wait until thestatus is ready. The AWS Dashboard displays the Launch Status.

20. Scroll down and click View Instance to view your OneCollect instance.

21. In the Description tab, copy the "IPv4 Public IP" or the “Private IP” and paste it in a browser.

OneCollect Dashboard is displayed.

Note: Collected data files can be found inside the docker instance at /NetApp/data/OneCollectData/JobFiles/, Config and Database files are available at /NetApp/data/NetApp/OneCollect/ and all the installation files are available at /NetApp/OneCollect/.You can choose to mount the volume on local file system to access the files directly by runningdocker as follows: docker run -d -p 80:80 -p 443:443 -v<Local_file_system_path_in_linux_style>:/NetApp/data netapp/

onecollect /NetApp/launch If port 80 and port 443 are in use on the system, you canspecify different ports (for example, 8050 and 7443) as follows: docker run -d -p8050:80 -p 7443:443 netapp/onecollect /NetApp/launch.

Installing OneCollect on Windows using the installationwizard

You can install OneCollect either on your system or you can host it in a central server that can beaccessed by multiple users.

Before you begin

• You must ensure that you have the required host system configuration, operating system, andbrowser to run the OneCollect tool.System requirements for OneCollect on page 6

• You must have downloaded the OneCollect executable binary for your platform.mysupport.netapp.com

Steps

1. Install OneCollect by completing the steps in the installation wizard.

The default installation folder for OneCollect on the Windows operating system is as follows:

Operating system Default installation folder

Windows 64-bit C:\Program Files\NetApp\OneCollect


http://mysupport.netapp.com/tools/info/ECMLP2671381I.html?productID=62128

Note: In the OneCollect Setup wizard, select "Yes" if you want to perform User Managementtasks and if you want HTTPS for OneCollect.

2. Choose a different path for data directory, if you want to change the default path.

3. Launch OneCollect from the URL: http://localhost:8044/OC/#/

If you have enabled HTTPS, then launch OneCollect from https://localhost.

Note: To configure the application to run on a different port, modify PORT value in theCONFIG file located in the <user_home_directory>\NetApp\OneCollect\Config andrestart the application (for example, PORT = 8040). To host the OneCollect server centrally tobe accessed from remote hosts, you can edit the config file and append the IP address to bindprefix to port (for example: PORT = 0.0.0.0:8044 will make it open to all hosts on all IPs.Alternatively, PORT = <dedicated_IP>:8044 will make it available on the specific IPconfigured on host).

After you finish

If you want to run OneCollect automatically during system startup, perform the following steps:

1. Navigate to <Install_directory>\NetApp\OneCollect\>, right-click ‘onecollect.exe’ andselect copy.

2. Find the Startup folder in All Programs and right-click it.

3. Click Open, and it opens up in the Windows Explorer.

4. Right-click anywhere inside that window and click the shortcut.OneCollect shortcut should pop up inside the folder, and the next time you log into Windows,OneCollect launches automatically.

Installing OneCollect on Windows using software archiveYou can install OneCollect either on your system or you can host it in a central server that can beaccessed by multiple users.

Before you begin

• You must ensure that you have the required host system configuration, operating system, andbrowser to run the OneCollect tool.System requirements for OneCollect on page 6

• You must have downloaded the OneCollect executable binary for your platform.mysupport.netapp.com

Steps

1. Browse to the folder where you have downloaded the software archive (.zip file).

2. Right-click the zip file and select "Extract here". Change directory to the extracted folder<download path>\NetApp\OneCollect.

3. If you want to customize the OneCollect data directory path, create a file with "data_dir.txt" under<install dir>\NetApp\OneCollect\ and enter the path where you want to place thedatabase and result files.

4. If you are upgrading from an earlier version or reinstalling OneCollect, you need to uninstallOneCollect manually. For information about uninstalling OneCollect on Windows, see Uninstalling OneCollect from a Windows host on page 37.

12 |

http://localhost:8044/OC/#/

http://mysupport.netapp.com/tools/info/ECMLP2671381I.html?productID=62128

5. Click and launch onecollect.exe under <install dir>\NetApp\OneCollect\ .

6. Launch OneCollect from the URL: http://localhost:8044/OC/#/.

Note: To configure the application to run on a different port, modify PORT value in theCONFIG file located in the <user_home_directory>\NetApp\OneCollect\Config andrestart the application (for example, PORT = 8040). To host the OneCollect server centrally tobe accessed from remote hosts, you can host it using https by editing the CONFIG file andenter ‘HOSTED = True’

After you finish


1. Navigate to <Install_directory>\NetApp\OneCollect\>, right-click ‘onecollect.exe’ andselect copy.

2. Find the Startup folder in All Programs and right-click it.

3. Click Open, and it opens up in the Windows Explorer.

4. Right-click anywhere inside that window and click the shortcut.OneCollect shortcut should pop up inside the folder, and the next time you log into Windows,OneCollect launches automatically.

Installing OneCollect on Mac OS XYou can install OneCollect on your Mac OS X system.

Before you begin

Your host system must either run a version of Mac OS X 10.10.x or Mac OS X10.11.x on yoursystem.

Steps

1. Browse to the directory where you have downloaded the tar.gz installer.

2. Extract it by running tar tar -xzf onecollect1.4_mac64.tar.gz.

Note: If you are downloading OneCollect using the Chrome browser, it automatically extractsin to a .tar file. In this case, run tar -xf onecollect 1.4_mac64.tar.gz.

3. Change directory (cd) to the extracted folder.

4. If you want to customize the OneCollect data directory path, create a file with a name as"data_dir.txt" under <install dir>/NetApp/OneCollect/ and enter the path where you want to placethe database and result files.

5. Type ./onecollect, if you have admin privileges or sudo ./onecollect. If you do not have adminprivileges, then press Enter.

Use ‘nohup ./onecollect &’ to run process in the background. OneCollect will start running onport 8044. Ensure that the port is free before running OneCollect. Database will be saved in yourhome directory under NetApp/onecollect/Db folder.

Note: To configure the application to run on a different port, modify PORT value in theCONFIG file located in the <user_home_directory>/NetApp/OneCollect/Config and restart theapplication (for example, PORT = 8040). To host the OneCollect server centrally to beaccessed from remote hosts, you can edit the config file and append the IP address to bindprefix to port (for example: PORT = 0.0.0.0:8044 will make it open to all hosts on all IPs.


http://localhost:8044/OC/#/

Alternatively, PORT = <dedicated_IP>:8044 will make it available on the specific IPconfigured on host).

After you finish


1. Choose Apple menu > System Preferences and click Users & Groups.

2. Select the user and click Login Items.

3. Click the Add button ‘+’ under the list on the right, select ‘onecollect’ from <install_dir>/onecollect.

4. Click Add.

Installing OneCollect on LinuxYou can install OneCollect on your Linux system through the command-line interface. You mustperform this task if you are installing OneCollect for the first time.

Before you begin

• Your Linux host system must either run a version of RHEL (later than 6.4) or an Ubuntu (laterthan 12.0).

• You must have downloaded the OneCollect executable binary for your platform.

• You must have the necessary privileges to install the application.

Steps

1. Browse to the directory where you have downloaded the tar.gz installer.

2. Extract it using tar command : tar -xzf onecollect1.4_linux64.tar.gz.

Note: If you are downloading OneCollect using the Chrome browser, it automatically extractsin to a .tar file. In this case, run tar -xf onecollect 1.4_linux64.tar.gz.

3. Change directory (cd) to the extracted folder.

4. If you want to customize the OneCollect data directory path, create a file with a name as"data_dir.txt" under <install dir>/NetApp/OneCollect/and enter the path where you want to placethe database and result files.

5. Type ./onecollect if you have admin privileges or sudo ./onecollect if you do not have adminprivileges, then press Enter.

Use "nohup ./onecollect &" to run process in the background. OneCollect will start running onport 8044. Ensure that the port is free before running OneCollect. Database will be saved in yourhome directory under NetApp/onecollect/Db folder.

Note: To configure the application to run on a different port, see Installing OneCollect on MacOS X on page 13.

If you are not installing the application as root, use sudo while running the commandsmentioned in the preceding steps.

After you finish


14 |

1. Edit the rc.local file (vi /etc/rc.local).

2. Add a line at the end of file to start the OneCollect process (nohup /path_to_onecollect/onecollect&).

3. Modify the permission for rc.local (chmod +x /etc/rc/local)The OneCollect process will start up automatically in the next reboot.

Editing data collection preferencesYou can edit user settings—such as AutoSupport, collection, encryption, and Email notification.

Before you begin

The following information must be available:

• Email address from which the alert notification is sent.

• Host name, default port, user name, and password to configure the SMTP server.

About this task

When you modify the settings, the changes are applied immediately.

Steps

1. Click Settings on the upper-right corner.

2. In the Basic Settings dialog box, modify the appropriate settings.

If you want to... Then...

• Enable OneCollectAutoSupport(recommended) —AutoSupport Settings

• Configure Proxy

a. Select the Enable OneCollect AutoSupport (recommended) checkbox.

b. Select the Configure Proxy check box to access the Internet (forAutoSupport posting).

Set up email notification —Email Notifications

You can configure SMTP to enable email notification for completed jobs.Optionally, you can enable email notification for scheduled jobs. Theemail will contain details about the devices that are part of job, job status,and parameters.

a. Select the Enable Notifications for Scheduled Jobs check box, ifyou want to receive notifications for scheduled jobs.

b. Select the Enable Notifications for Unscheduled Jobs check box, ifyou want to receive notifications for unscheduled jobs.

Enable or disable Telnet —Collection Settings

You can either enable or disable Telnet across all data collection (to avoidflags/alerts in a secure environment).

Set up encryption option —Encryption Settings

You can set one-time pass phrase to encrypt saved credentials for thedevice.

3. Click Save to save the settings.


Hosting OneCollect with nginx (HTTPS)

You can host OneCollect, at a centralized location, for using OneCollect with nginx (HTTPS).

Note: To enable user management feature on Mac and Linux, edit the CONFIG file located at ~/NetApp/OneCollect/Config/ and add this entry: HOSTED = TRUE

The information is applicable for the following operating systems:

On Mac

• Command to install nginx - brew install nginx

Install paths:

• nginx executable install path - /usr/local/bin/nginx

• nginx config dir - /usr/local/etc/nginx

On Linux – RHEL

Command to install nginx - yum install nginx

Install paths:

• nginx executable install path - /usr/sbin/nginx

• nginx config dir - /etc/nginx

On Linux- Ubuntu

• Command to install nginx - sudo apt-get install nginx

Install paths:

• nginx executable install path - /usr/sbin/nginx

• nginx config dir - /etc/nginx

Generate SSL domain_name.key and domain_name.cert on the system:

Commands:

• sudo openssl genrsa 1024 > domain_name.key

• sudo chmod 400 domain_name.key

• sudo openssl req -new -x509 -nodes -sha1 -days 365 -key domain_name.key

-out domain_name.cert

Creating user accountsIf multiple people in your organization need to use OneCollect, then you need to create user accountsfor each user. When you are using the User Management feature of OneCollect, you can create twotypes of users: Admin and User. The Admin and User have the privilege to create jobs, manage jobs,and manage users.

About this task

The two roles that are assigned to the users are Admin and User. The following table lists two of theuser-interface operations.

16

Roles Operation

Admin You can add, delete, or edit user account(s). Inaddition, you can also view and delete jobs,saved projects, and scheduled jobs across all theusers. You also have the privilege to resetpasswords for the user accounts. As an Admin,you can assign one of the users with the Adminprivileges.

Note: You can create a maximum of 10 useraccounts.

User As a user, you can only view and manage jobsthat you have created. You can create, delete,and change the settings of only your account.

When you create a new user, the user is added to use OneCollect with applicable permission settings.

Steps

1. Click the User Management tab.

2. Click Create User.

The Create a User prompt is displayed.

3. In the Username box, enter your user name.

4. In the Password box, enter the password.

5. Enter the email addresses of the role that you want to select for a particular account.

6. Select one of the roles, Admin or User, which you want to assign to the user.

7. Click Submit.

Replacing nginx.conf fileYou can replace nginx.conf file in OneCollect for using OneCollect with HTTPS.

Steps

1. Copy nginx.conf from OneCollect install directory and replace it with the nginx.conf file that islocated at the config directory specified in the preceding section.

2. Edit the server_name with the IP address or host name, ssl_certificate with the path ofdomain_name.cert generated on the system and ssl_certificate_key with the path ofdomain_name.key generated on the system.

For example, server_name - 10.141.39.131 (IP address of the system); ssl_certificate /home /domain_name.cert; ssl_certificate_key /home / domain_name.key;

Hosting OneCollect with nginx (HTTPS) | 17

Running OneCollect with nginx on Mac and Linux hostsYou can run OneCollect with nginx on Mac and Linux hosts for using OneCollect with HTTPS.

Before you begin

Make sure that you have installed nginx on your system.

Steps

1. Go to nginx installed folder (for example, /usr/sbin) and type chmod 777 nginx (to provide allpermissions).

2. Type ./nginx -t to check if configuration is correct.

3. Kill all the earlier nginx processes running on the system: Use the command ps -ef|grepnginx / kill -9 pid.

4. Run nginx as: sudo ./nginx.

5. Extract the OneCollect install directory.

6. Navigate to the OneCollect install directory.

7. Create a file "https" in the OneCollect install directory. Use the command: touch https.

8. Run ./OneCollect.

9. Launch OneCollect with "https". For example, https://10.141.39.131 from your browser.

Note:

• In case port 443 is used by another application, change the port to any other available port byediting nginx.conf and changing the value listen 443; to listen 8043;.

• When running nginx as sudo ./nginx, If you get ‘/etc/nginx/log/access.log" failed’ error onlinux, create the directory as ‘sudo mkdir -p /etc/nginx/log’.

18 |

Deploying a OneCollect Amazon Machine Image

OneCollect Amazon Machine Image is provided through the Amazon Web Services portal. Itrequires deploying the OneCollect instance. You can configure access to the OneCollect AMIinstance using a web browser. When the OneCollect AMI is deployed, you can access OneCollecteasily.

Deploying a OneCollect AMIThe OneCollect cloud-based instance is built specifically for deployment within the Amazon EC2compute environment. Using the OneCollect instance requires deploying the instance, setting upaccess to the appliance, and configuring a static IP address.

Steps

1. On the Choose an Instance Type page, retain the default selection. Otherwise, select the instancetype as per the scale you want.

2. Click the Network drop-down list to select the virtual private cloud (vpc) from the drop-downlist.

3. Click the Subnet drop-down list to select the subnet.

4. Click Next: Add Storage.

The Add Storage page appears. Default selection of 8 GB storage is good enough for runningOneCollect, however, if you want to use OneCollect for data collection from large number ofdevices, then you can increase the size.

5. Click Next: Add Tags.

6. On the Tag Instance page, optionally provide a value for the key name and value to identify theinstance, and then click Next: Configure Security Group.

7. Choose a Security Group for the OneCollect instance.

8. Review the Assign a security group option buttons and select one option that allows OneCollectto access HTTP and HTTPS protocols for connection. You can also assign the SSH policy forlogging into the instance for troubleshooting.

9. You also have an option to create a policy by clicking Add Rule.

10. Click Review and Launch.

11. Review the launch instance details, and then click Launch.

12. If you have an existing key pair, choose the key pair from the Select a key pair drop-down list.

Otherwise, create a new key pair.

Note: If you select Proceed without a key pair option, you will not be able to access the logsand files for troubleshooting.

13. Click Launch Instances.

After you have completed the process successfully, your instances start launching. Wait until thestatus is ready. The AWS Dashboard displays the Launch Status.

14. Click View Instance to view your OneCollect instance.

19

15. In the Description tab, copy the "IPv4 Public IP" or the “Private IP” and paste it into a browser.

Set the Admin password and log in to OneCollect.

Note: Collected data files can be found inside the AMI instance at /NetApp/data/OneCollectData/JobFiles/, Config and Database files are available at /NetApp/data/NetApp/OneCollect/ and all the installation files are available at /NetApp/OneCollect/.If you want to restart service by logging in to the AMI instance, search for "nginx" and"onecollect" process and kill them. Restart by running the "launch" script under /NetApp (./launch).

Accessing the OneCollect Amazon Machine ImageThe OneCollect Amazon Machine Image (AMI) is an AltaVault cloud-based appliance instance builtspecifically for deployment within the Amazon EC2 compute environment.

Steps

1. Log in to the Amazon Web Services portal, and then browse to the Amazon Marketplace.

Amazon Web Services (AWS) Marketplace

2. Click Services.

3. From the Compute section, select the EC2 instance.

4. Click Launch Instance.

5. Click AWS Marketplace.

6. Search for the OneCollect instance and click Continue.

7. On the Choose an Amazon Machine Image (AMI) page, select the OneCollect AmazonMachine Image (AMI).

8. Click Continue.

20 |

https://aws.amazon.com/marketplace

Upgrading OneCollect

You can upgrade to a different version of OneCollect or reinstall the same version on eitherWindows, Mac, or Linux system(s). You can use one of the two options for upgrading OneCollect.

About this task

When you upgrade OneCollect and install it on your system, you will get two options:

Steps

1. Based on your requirement, select one of the options on your Windows system.


Perform a clean install Click Yes for clean installation. The installer will delete the database andperform a clean installation.

Perform an upgrade Click No to upgrade. The installer will retain the database files, which inturn retains the user preferences.

2. Select one of the options to upgrade OneCollect on either Mac or Linux system.


Perform a clean install a. You must delete the database and Config file by running rm -rf ~\NetApp\OneCollect.

b. Delete the older install directory.

c. Install the new version by running ./onecollect from theextracted installer package under <download path>\NetApp\OneCollect>.

Perform an upgrade a. Delete the older install directory.

b. Install the new version by running ./onecollect from theextracted installer package under <download path>\NetApp\OneCollect>.

21

Collecting and uploading data from devices usingOneCollect

The OneCollect tool enables you to collect diagnostic, SAN, NAS, and performance data from hosts,switches, and storage systems. OneCollect provides additional content, which can be sent back toNetApp or analyzed on premises to understand customers' environments. You can use three differentprofiles to collect data. In addition, you can schedule a data collection job, edit the saved job, viewthe collected data, and upload the collected data to AutoSupport.

Collecting data using OneCollectOneCollect enables you to collect data from different types of devices and solutions.

About this task

Using OneCollect, you can collect data by configuring a new collection profile:

• Device Based profile: This helps you collect data from single or multiple homogenous/heterogeneous set of devices that could be storage controllers, switches, or hosts. You need toenter the credentials of the device or component for collecting data.

• Solution Based profile: This helps you collect data from a set of preconfigured solution stacks.

Note: You can collect data using any of these preceding profiles, but if the size of the collecteddata exceeds 50MB, then the data cannot be uploaded to AutoSupport.

22

• ASUP Based profile: This helps sending the collected configuration data back to NetApp throughits own AutoSupport. This information is used by NetApp Support and partners to improveproblem diagnostics.

• Discover IP/IP Range profile: This helps you discover devices automatically using an IP, IPrange, or subnet.

• Import Devices profile: This helps you to load the file that have the device information. Afteryou import, Config Advisor displays the IPs that were identified from the imported data.

• Import Collected Data Files profile: This helps you to load the data collected from anothersystem using either OneCollect or Config Advisor and import the collected data files for analysis.

Collecting data using the device-based collection method

You can collect data from storage controllers, hypervisors, hosts, and switches (FC and Ethernetswitches). You can also collect data either from one device or multiple homogeneous andheterogeneous devices.

Steps

1. Click Data Collection Jobs tab.


Manually enter device details Add the components, choose the device type and subtype, and thenchoose its relevant credentials.

Note: SnapCenter plug-in is added in OneCollect to gather the Joblogs from a SnapCenter server. You can either enter a single Job ID, arange, or a comma-separated list of Job ID values. OneCollect willsave the collected log files in the Job directory.

Automatically load devicecredentials from a file

Select the collection type Import Devices and browse a file that hasdevice details in a predefined format (Import_Credentials.csv). This CSVfile is available in the OneCollect install directory.

For optimal performance, NetApp recommends adding a maximum of 25 devices.

2. By default, the Device-Based collection type is loaded.

3. By default, one row relevant to one device is loaded. If you want to add more devices, click theClone button under the Actions column.

4. OneCollect validates the credentials of device(s) in two ways:

a. Auto validation for one device: Enter the host name, username, and password and move tothe next row, the validation of the previous device starts automatically.

b. Manual validation for all the devices: Enter the host name, username, and password andclick the Validate button.

5. By default, all the commands are selected for the device. If you need to modify the commands,click the Commands icon under Actions column.

6. Click the Collect button to proceed with data collection.

Collecting and uploading data from devices using OneCollect | 23

Collecting data from ONTAP enabled with Multifactor authentication

Starting with ONTAP 9.3, you can enable SSH multifactor authentication (MFA) for localadministrator accounts. When SSH MFA is enabled, users are authenticated by using a public keyand a password.

About this task

If you have enabled SSH multifactor authentication (MFA) on ONTAP system, then you mustperform the following steps:

Steps

1. Click the Data Collection Jobs tab.

2. Select Device Based from the Collection Type drop-down list.

3. Select Storage Controller from the Type drop-down list.

4. Select ONTAP from the Sub Type drop-down list.

5. Select the persona that you want from the Persona drop-down list.

6. Enter the credentials.

7. Select the Enable MFA check box, and then enter the absolute path to SSH private key under theSSH MFA Key Path field.

8. Click Validate button to validate the devices.

9. Click Save/Collect button to save or collect the data.

Collecting data using the solution-based collection method

Solution-based profile is a predefined profile. By using this profile, you can configure data collectionfor solutions, such as E-Series, FlexPod, ONTAP, Data ONTAP 7-Mode, and other solutions.

About this task

To perform a minimal data collection, you should enter the credentials for switch, node, cluster, andserver.

Steps


2. Choose Solution Based option from the Collection Type drop-down list.

3. From the Profile drop-down list, select the required profile, for example, ONTAP.

4. Select Network from the Sub Profile drop-down list.

5. From the Persona drop-down list, select General.

For more information about Personas, see

Overview of OneCollect on page 5.

6. Select the appropriate cluster switch model and management switch option.

7. By default, one row relevant to one solution is loaded. If you want to add more solutions, click theClone icon under the Actions column.

24 |

8. OneCollect validates the credentials of solution(s) in two ways:

a. Auto validation for one solution: Enter the host name, username, and password and move tothe next row, the validation of the previous solution starts automatically.

b. Manual validation for all the solution: Enter the host name, username, and password andclick the Validate button.

9. By default, all the commands are selected for the solution. If you need to modify the commands,click the Commands icon under the Actions column.

10. Click the Collect button to proceed with data collection.

Collecting data using Serial port

You can use the Serial port if you do not have access to the customer’s network. Direct access to thecontroller firmware is gained through the serial port. It appears in the Solution-based profile.

Steps

1. Connect Serial ports from ONTAP system (optionally switches) to the laptop on whichOneCollect is installed.

2. Click New Data Collection.

3. Select the Solution-based profile.

4. From the Profile drop-down list, select the required profile, for example, ONTAP.

5. From the Persona drop-down list, select any one persona from the drop-down list.

For more information about Personas, see Overview of OneCollect on page 5.

6. From the Sub profile drop-down list, select Serial.

7. Enter credentials for the systems.

8. To validate, click Next.

9. Click Next to view the summary of devices from which the data will be collected.

Collecting data using AutoSupport method

NetApp technical support can view the data collected from the customer environment for analysisusing AutoSupport.

About this task

You can select one of the two options to collect data.

Note: Parsing will not work on the data collected using AutoSupport profile.

Steps


2. From the Collection Type drop-down list, select ASUP Based profile.

3. Select any one of the two options to collect data.



Collecting data usingAutoSupport (by ASUP ID)

a. In the New Data Collection page, you can either add a file (.csvor .txt format) containing multiple AutoSupport Ids.Multiple AutoSupport IDs are displayed in the ASUP ID columnalong with their connection statuses.

b. Alternatively, you can add an AutoSupport id using one of thefollowing methods:

i. Select the date from the Date Range.

ii. Click Add File to add the file with ASUP ids.

iii. Click Add ID to enter the Id in the ASUP ID field.

iv. Enter serial number of the controller in the Search By Serial No.field, and click Search.

v. Enter the hostname of the controller in the Search By Hostname.

vi. Select ASUP ID.

vii. Enter the Job ID to load the IDs using OneCollect Job_Id fromASUP.

c. Select Fetch all nodes of the cluster check box to stitch togetherentire cluster (all nodes) based on the ASUP_ID or Serial_no or hostname.

You can also load old analysis, rerun analysis, and obtain the latestAutoSupport for cluster and run analysis.

Note: This feature works only for the internal users.

Collecting data usingAutoSupport (by ASUP File)

a. In the Data Collection Jobs tab, select the ASUP Based option fromthe Collection Type drop-down list.

b. Click Browse to select an AutoSupport file, for example, ONTAPAutoSupport file.

c. You can select the Pull data for analysis check box to collect onlythe data required for analysis.

Note: AutoSupport files in the .tgz and .txt formats are supported.

d. You can view the AutoSupport profile in the Profile drop-down list.

e. Click Collect Now to proceed with data collection.

f. View the icons under Action column to perform different tasks, suchas viewing the collected data, viewing and analyzing the data in theCommand Viewer, or deleting the job.

g. Click the file under the Job Name column to view the recent jobs andCommand Viewer and to export the report in three different formats:PDF, Word, and Excel.

26 |

Collecting data using OneCollect's Host Performance Plug-In

The OneCollect's Host Performance Plug-In is used for assessing the performance of host(s) inaddition to providing data for sizing recommendation.

Before you begin

Before you collect vCenter data, you should have completed the following tasks:

• You must have the token with you.

• For vCenter data collection, OneCollect uses vCenter WebServices API. This requires ManagedObject Browser (MOB) to be enabled on vCenter. Starting with vCenter version 6.0, MOB wouldbe disabled, by default. To enable it for data collection, see VMware KB article.

• For host performance sizing, the counters are used. If these counters are not available for aparticular host or virtual machine, the accuracy of sizing recommendation is affected.

• You should have created a project to be able to size the data.

• The credentials used for data collection can be administrator or any user with at least"RetrieveAllPermissions."

About this task

The host performance Plug-In helps in collecting all the information required to generate the sizingreport. It provides the ability to set collection intervals and duration of the host performance datacollection.

Steps

1. Open OneCollect.

2. On the Data Collection Jobs page, select Performance from the Collection Type drop-downlist.

3. Click Create a new data collection link.

4. Select Performance from the Collection Type drop-down list.

5. Type the Hostname or IP and Password fields.

In the Token prompt, enter the token.

If you click the Validate button, OneCollect will validate the token. If you click, the Skip button,Collect Options dialog box is displayed.

6. Click either the Validate or Save/Collect button based on your requirement.

7. For uploading data to AutoSupport, enter the information in all of the required fields. It ismandatory to enter the token in the Token field. Enter the token that has been fetched andvalidated to upload OneCollect data collection files to NetApp AutoSupport.

Note: You can neither edit nor reschedule the saved projects of host performance. In this case,you should schedule the project again. Scheduling and saving the project are mandatory tasksfor creating the collection projects.

If the token validation is successful, then the collected data is posted to NetApp AutoSupport atthe end of collection duration (performance data collection cycle). In parallel, the data collectionis performed for a few devices, but only a maximum of 20 devices can be added. For vCenter, it isrecommended to add a single vCenter Server to the job while collecting data from all of themanaged ESXi hosts and virtual machines managed by vCenter.


https://kb.vmware.com/s/article/2108405

8. Click the Save & Collect button.

You can view the job in the Data Collection Jobs page.

Collecting data using SnapCenter Plug-in

The SnapCenter Plug-in will help you check the configuration patterns, issues, and specificenvironment scenarios of SnapCenter.

About this task

SnapCenter being a data management product that caters to multiple sets of use cases supportsseveral sets of configuration possibilities across its stack. This includes multiple aspects, such as theserver configuration, application plug-in configuration involving host configuration of differentoperating systems and various configurations of different applications, configurations relating to thevirtualization environment, storage system configuration, and others. The goal of this plug-in is toidentify the environment, which needs to be managed by SnapCenter and provide recommendations,corrective actions, and notifications to you so that you can take the next set of relevant actions for thesmooth functioning of SnapCenter. The SnapCenter Plug-in helps in performing data collection,parsing of collected data, and running a set of rules on the parsed content. The SnapCenter Plug-inhelps in performing the following tasks:

• Collection of data for a set of storage virtual machines (SVMs), hosts, and vCenters, which youselect in the OneCollect interface.

• Collection of data based on an existing SnapCenter server which the user has provided.

◦ Data collection occur automatically for the SVMs, hosts, and vCenters, which are configuredwith the SnapCenter server instance.

Note: The SnapCenter Plug-In profile copies and executes NetApp\OneCollect\plugins\SnapCenter\linux_config_check.sh to the /tmp folder on Linux hosts when running datacollection.

Steps

1. Click Create a New Data Collection.

2. Select the Solution-based profile for the collection type.

3. Select the SnapCenter profile.

4. For sub profile, select Data Collection and persona LogAnalysis.

5. For sub profile, select Data Collection for configuration checks and persona Analysis. Selectwhich type of configuration check do you want to select between the two checks, SnapCenterServer Pre-Install or SnapCenter Server Post-Install.

6. Type the credentials in the Hostname or IP and Password fields.

7. If you click Validate, OneCollect will validate the credentials.

8. Click Save/Collect and provide your single sign-on (SSO) credentials in the NetApp User Logindialog box.

9. If you do not want to provide your credentials, you can click Skip.

10. Provide the information in the Collect Options dialog box.

11. Click View & Analyze to view the health report and device details.

12. Click View Collected Data to view the command viewer.

28 |

Uploading Host Performance data files to AutoSupport

In OneCollect, you can save and schedule a project after you have collected the data. You can alsoupload the data files to NetApp AutoSupport. Upon successful completion of uploading the files toAutoSupport, you will receive a confirmation mail with the project details.

Before you begin

Before uploading the data files to AutoSupport, ensure that you have the following:

• A token for uploading the data files automatically.

• The token is one-time token; therefore, it must not have been used earlier. The token is valid onlyfor 30 days.

• Uninterrupted Internet network for uploading the data files automatically.

About this task

You can upload data files to NetApp AutoSupport after you have collected the data usingPerformance plug-in. You can use one of the following three methods for sending data files toNetApp AutoSupport.

• Upload the data files automatically: This scenario is used when you can access both the Internetnetwork and lab network. You must specify a start date for the collected performance data thatyou want to upload. When you schedule the job, you must enter the start date time and end datetime for the job you want to collect data. For example, if today is May 20, you can specify a startdate of May 20 and end date of May 30. On May 30th, OneCollect will automatically upload thedata to AutoSupport if the token is validated at the beginning of data collection. The requirementfor this upload is that you should have uninterrupted Internet network connection and a validtoken for uploading the data.

• Import Performance data and upload the data files manually: This upload is used when thedata has been collected either by prospective customers, existing customers, or partners. Thisupload is used when you experience the following scenarios, either you do not want to share thesensitive data, you do not have a token, if you have a token but it is invalid, or you do not have theInternet access. In this case, you can send the collected data in either a .zip or .tar format toNetApp representative. The NetApp representative then imports these files to OneCollect andchoose to upload the data files manually.

• Upload the Job files manually (Switch between the lab environment network and outside theInternet network): This scenario is when you have to switch between the lab environmentnetwork and outside the Internet network.


Upload the data filesautomatically

For information about uploading data files automatically, see Collectingdata using OneCollect's Host Performance Plug-In on page 27.


Import Performancedata and upload thedata files manually

1. Zip the collected data folder in either tar, zip, or tar.gz format.The collected data folder will be available in the Scheduled Jobs tabData Collection tab > Group name.

2. Send it to the NetApp representative.

The NetApp representative will perform the following steps:

1. Open OneCollect.


3. Click Create a new data collection link.

4. Select the Import Performance Data from the Collection Typedrop-down list.

5. Click Browse to select the file.OneCollect validates whether or not all the files of that particularcollection are present.

6. You can view the data files in the Data Collection Jobs tab.

7. Click Upload to AutoSupport tab.

8. Select the project name.

9. Click Upload.

10. Enter the valid token in the Token prompt along with the start andend date for scheduling the project.

Upload the job filesmanually (Switchbetween the labenvironment networkand outside theInternet network)

1. You can complete collecting data inside the lab environment network.When you complete scheduling the job, it gets displayed in Uploadto AutoSupport.You can now return to the outside Internet network.

2. Select the collection job.

3. Select the job name.

4. Enter the token.

Upon successful upload, you will receive a mail containing Project IDdetails and a link for accessing your project details that have beenuploaded.

Discovering devices automatically and collecting data

You can automatically discover devices in an IP, IP range, or subnet by using OneCollect. OneCollectuses Simple Network Management Protocol (SNMP) v2 for automatic discovery. If the discovery issuccessful, OneCollect also identifies the device type and its operating system.

About this task

You can collect data by using three methods:

Step

1. Click Discover.

30 |


Discover IP, IP range, andsubnet automatically

a. Enter the IP, IP Range , or subnet in the field.For example, 10.238.192.90-100; subnet 10.238.190.0/24.

b. Click Discover.All the discovered devices for which SNMP was successful, devicetype and subtype get loaded. You can select the check boxes to adddevices for collecting and saving data. If SNMP has failed, you canmanually map the device type and subtype if you recognize thesystem.

c. Select the devices that you want for data collection.

d. Enter the credentials.

e. Validate the devices.

f. Click Save/Collect.

Import devices a. Click Import Devices option.

b. Click OK.

c. Load the devices from the csv template.

Note: The CSV template can be found in the OneCollect installdirectory.

The devices will be displayed in a tabular format for editing andupdating. You can update the credentials for multiple devices in the listgiven using Update Credentials link.

It is optional to validate the credentials. If you are sure about thecredentials and devices added, you can either click Save/Collect orCollect.

Import collected data files a. Under Discover tab, select the Import Collected Data Files optionbutton.

b. Click OK.

c. Load the OneCollect data file that has been shared by another user.

It will directly get added as a job and you can view the collected data inData View.

Note: Using this option, you can load the data collected from anothersystem using OneCollect or Config Advisor.

Scheduling a data collection jobYou can create a scheduled backup job by selecting an entire job start time and recurrence pattern forthe saved job. You can also view all backup jobs on the Saved Projects page.

Before you begin

OneCollect must have at least one of the jobs saved for scheduling a job.

Steps

1. Select a saved job.


2. Click the Edit Schedule icon.

3. In the Scheduler, enter the exact time that you want the scheduler to set for the saved job.

4. Click Save.

5. In the Recurrence Pattern pane, enter the details in the respective fields.


Set the interval a. Select the Hours and Minutes from the Trigger Every field.

b. Enter the occurrence of the job in the Occurrence field for the job tobe scheduled.

c. Click Save Schedule.

d. Click Close.

Set for daily schedule a. In the Start Time drop-down list, enter the time in the Hours andMinutes fields.

b. Enter the frequency of days in the Recur Every How Many Days?field for the job to be scheduled.

c. Enter the occurrence of the job in the Occurrence field for the job tobe scheduled.

d. Click Save Schedule.

e. Click Close.

Set for weekly schedule a. Select Weekly from the Recurrence Pattern drop-down list.

b. In the Start Time drop-down list, enter the time in the Hours andMinutes fields.

c. Select either one day of the week or you can also select all the daysof the week.

d. Enter the occurrence of the job in the Occurrence field for the job tobe scheduled.

e. Click Save Schedule.

f. Click Close.

6. Monitor the job progress and execution logs for scheduled jobs.

Editing a saved jobYou can edit a job even after you have saved the job.

Steps

1. In the Saved Projects tab, under the Actions column, click the Edit Project icon.

2. In the Data Collection Jobs tab, modify the information that you want.

3. Alternatively, click Validate to verify the information.

4. Click Save/Collect to save or collect data.

32 |

5. In the Collect Options dialog box, you have an option to enter the name of the Project Name,Group Name, Pass Phrase, and Confirm Pass Phrase.

6. Click Save Project button.

Viewing collected dataYou can view the collected data from hosts, switches, and storage systems.

About this task

A new feature has been introduced to group jobs by the saved project name. You can switch the viewbetween "Jobs Grouped By Project" or "Latest Jobs Across Projects" which is sorted based oncreated timestamp. If the recent running collection job is from the scheduled job or Host Performanceprofile, by default, the jobs' page is redirected to the "Jobs Grouped By Project" view.

Step

1. To view collected data, perform any one of the following methods:


View data of all the recent jobfiles

a. Click the Data Collection Jobs tab.

b. Select the icons to perform any one of the following operations:

i. Expand to view more information about the job.

ii. Collect data.

iii. View the command viewer.

iv. View and analyze the collected data.

v. Delete the collected data.

The Command Viewer will be launched.

c. View the collected data in an .xml format.

d. Click the expand symbol (>>) to view a realtime log console.You can view the path of the file. You can select either one or morejobs to export the data into a consolidated report in PDF, Word, orExcel formats.

e. Click the file under the Job Name column.You will reach the View & Analyze page to view the health report,device details, visualization diagram, and storage utilizationpertaining to that particular job. The information under these boxesare clickable. For example, when you click the NetApp storagecontroller in the Device Type column inside the Device Details box,you have an option to narrow down your search to obtain informationabout the system configuration summary, aggregate info, volumeinfo, and LUN info in addition to viewing the stack and visualizationdiagrams.

f. Click Export to export the job information.

g. Click Command Viewer to view the commands used in the selectedjob.



View data for one job file a. Click View & Analyze tab.

b. On the left-hand side, click the job link.

c. View all the recent jobs that are listed out.

d. Select the job that you want to view for additional information.

Understanding IMT Advisor

IMT Advisor helps you perform IMT validation with ONTAP, protocol, and host collected data.

Before you begin

You must have collected the data and it should be added as a job in the Data Collection Jobs page.

About this task

Automated IMT validation of configuration helps you find the supported and unsupportedconfigurations, path failure risks, and upgrade recommendations.

After you have collected the data, you can check whether the components that you have chosen aresupported or unsupported. For example, you have selected ONTAP 8.3 and Windows 2012, you cancollect data including these two components. IMT Advisor will identify whether these twocomponents are supported, for example, ONTAP 9.0 and Windows 2012 and it will confirm whetherthis combination will support the existing environment. It will validate the collected data against allof the latest versions of ONTAP and Windows.

Steps



3. Select at least one supported host (RHEL, SuSe Linux, ESX, ESXi, HPUX, AIX, Solaris, andWindows) for data collection.

4. Under the Action column, click the IMT Advisor View icon.

On the Add-ons page, the parsed data and corresponding IMT components are displayed.

5. Select the checkbox(s) for either one or more host(s) that you want.

Note: You must review whether the mapping details are correct on this page before youproceed to the next step. If there are matches, a drop-down will be displayed allowing you toselect the exact version.

6. Click Next to view supportability.

You can view whether the combination that you have selected is supported or not.

7. Click Interop Advisor link to see the upgrade recommendations.

Note: You can use Interop Advisor only if you have uploaded the collected data toAutoSupport. For more information about uploading the collected data to AutoSupport, see Collecting and uploading data to AutoSupport on page 35.

34 |

Collecting and uploading data to AutoSupportOneCollect collects and sends the collected data of your systems and sends messages to NetApptechnical support. You can change the AutoSupport schedule, download AutoSupport messages fortroubleshooting, and send an immediate AutoSupport message to NetApp technical support.

About this task

You can generate and send an AutoSupport message that contains collected demographic data.

Steps

1. Open OneCollect.

2. Select Data Collection Jobs.


4. Select Device Based profile.

5. Add ONTAP, Host, and Switch (2 or 3) devices for data collection.

6. Alternatively, click Validate to verify the information.

7. Click Save/Collect.

8. Monitor job progress and execution log.

9. If posting to AutoSupport is enabled in the Settings options, OneCollect will automatically postthe collected data to AutoSupport after you have authenticated using the NetApp Single Sign On(SSO) once.

10. If the automatic posting is not enabled, perform the following steps to upload the required files:

If you want to... Then

Upload from files a. Select Upload From Files option.If you have the login credentials, you can directly upload the filescollected from OneCollect instances to Upload to AutoSupport. Ifyou do not have the login credentials, you can send the OneCollectdata files to a NetApp field engineer, who can then upload them toASUP. This feature helps you to upload files that were collected on asystem that do not have Internet access. You can copy the files to aUSB flash drive and upload them later to AutoSupport.

b. Enter details in the Case ID text box, also provide a description in theComments text box. However, this is optional.

Note: OneCollect supports only those files that are collected usingOneCollect.


If you want to... Then

Upload from jobs a. Click Upload From Jobs option.

b. Select the Job Name is your saved job.

c. Enter details in the Case ID text box, also provide a description in theComments text box. However, this is optional.

d. Click Upload ASUP button.

e. For validation, enter your user credentials in the NetApp User Logindialog box.

Your uploaded data will be sent to NetApp.

36 |

Uninstalling OneCollect

You can upgrade to the current version from earlier versions of the product. You can uninstallOneCollect to troubleshoot issues if they persist.

Uninstalling OneCollect from a Windows hostYou can uninstall OneCollect by using the Windows Uninstall program utility.

Before you begin

• OneCollect database file is available under <user_home_directory>\NetApp\OneCollect\Db>. To either avoid accidental deletion or losing your data forever, it is advised to back up thedatabase before you uninstall OneCollect.

• If OneCollect is running, it must be closed.

Step

1. Uninstall OneCollect from a Windows host if OneCollect was installed using the installationwizard or the software archive.


Uninstall OneCollect that wasinstalled using the installationwizard

a. Browse to the user directory path and delete NetApp and OneCollectfolders.

b. Click Control Panel.

c. Select Programs and Features.

d. In the wizard, right-click OneCollect and select Uninstall.You have successfully uninstalled OneCollect from your system.

Uninstall OneCollect that wasinstalled using the softwarearchive

a. Stop the OneCollect process from the Task Manager.

b. Delete the OneCollect install directory at<Install_directory>\NetApp\OneCollect.

c. If you want a clean uninstallation, delete the data directory foldersfrom <user home directory>\NetApp\OneCollect. Youcan retain this, if you want the settings and job data to be retained forupgrading or reinstalling OneCollect.

Uninstalling OneCollect from the Mac and Linux hostsYou can uninstall the OneCollect from the Mac and Linux hosts by using the command-lineinterface.

Before you begin

• OneCollect database file is available under <user_home_directory>\Netapp\OneCollect\Db>. To either avoid accidental deletion or losing your data forever, it is advised to back up thedatabase before you uninstall OneCollect.

37

• If OneCollect is running, it must be closed.

Steps

1. Kill the OneCollect process.

2. Delete the OneCollect install directory.

You have successfully uninstalled OneCollect from your system.

38 |

Troubleshooting

You can find information about how to troubleshoot some of the issues that you might come acrosswhen you use the OneCollect plug-ins. You can find details of the issue, possible cause, andworkaround for the issue.

Resolving OneCollect launching errorOneCollect does not launch on Windows, Mac or Linux system after installation.

About this task

To launch OneCollect on either Windows, Mac, or Linux system, perform the following steps:

Step

1. In a browser, manually enter the URL:

http://localhost:8044/oc/


Resolve OneCollectlaunching error on Windows

a. Check whether the OneCollect process is running in the TaskManager in Windows.

b. If the process is not running, go to the installation directory, bydefault <C:\Program Files (x86)\NetApp\OneCollect> and launch the OneCollect process by clickingonecollect.exe.If it still does not work, the port might be used by other application(check netstat -an).

c. To rectify this issue, edit the CONFIG file in the user directory<user home directory>\NetApp\OneCollect\Config> and set the PORT number to an available port. RestartOneCollect.If you are trying to access OneCollect from the other systems, makesure the firewall allows the port used by OneCollect.

Resolve OneCollectlaunching error on Mac andLinux

a. Check whether the process is running by executing ps aux |grep onecollect.

b. If the process is not running, go to the installation directory, bydefault <install_dir>/OneCollect> and launch theOneCollect process by running ./onecollect.If it still does not work, the port might be used by other application(check netstat -an).

c. To rectify this issue, edit the CONFIG file in the user directory<user home directory>/NetApp/OneCollect/Config> and set the PORT number to an available port. RestartOneCollect.If you are trying to access OneCollect from the other systems, makesure the firewall allows the port used by OneCollect.

39

http://localhost:8044/oc/

Backing up the databaseThe device credentials, saved jobs, and user preferences are saved in the database.

About this task

If you want to delete OneCollect, it is advised to back up the database to avoid losing your saveddata.

Steps

1. Navigate to <user_home_directory>\Netapp\OneCollect\Db>.

2. Back up the database folder.

Changing the default timeout for command executionYou can change the default timeout for command execution using the COLLECTION_TIMEOUTvariable in the Config file.

Steps

1. Open the Config file.

• Windows: <user_home_directory>\NetApp\OneCollect\Config

• Mac and Linux: <user_home_directory>/NetApp/OneCollect/Config

2. Change the value of COLLECTION_TIMEOUT to the desired time value (in seconds).

3. Save the file.

4. Restart the server.

The framework will include the new timeout value.

Restarting the OneCollect serverYou can restart the server on a host using either Windows, Mac, or Linux.

Step

1. Use one of the following methods to restart the OneCollect server.


Restart OneCollect on aWindows system

a. Right-click and select Start Task Manager.

b. Click Processes tab and select onecollect.exe.

c. Click End Process.

40 |


Restart OneCollect on a Macor Linux system

a. Search for OneCollect process using ps aux | greponecollect.

b. Note down the process ID of OneCollect and kill the process usingkill <pid>.

c. Restart the process by running ./onecollect from theOneCollect install directory.

Sending the feedbackYou must notify NetApp technical support if you want to send us your feedback, report a problem, orneed assistance in using OneCollect.

Steps

1. Click Help > Report a Problem.

You will be directed to the NetApp OneCollect Community Forum.

2. If you are a new user, register on the NetApp Community Forum.

3. If you are an existing user, sign in.

4. Enter the subject in the Subject line.

5. You must provide the description of your feedback, problem, or query related to OneCollect inthe Body section.

6. Add a file, if any, to the Attachment section.

7. You must either type OneCollect in the Label field or click OneCollect link provided under theChoose a Label section.

8. Click Post to send your feedback to NetApp.

Searching for the result and log filesAfter you have successfully collected the data, the result and log files are saved.

About this task

You can access the result and log files as listed in the table below:

Type of file File location

Log File <user home dir>/OneCollectData/

LogFiles>

Result file <user home dir>/OneCollectData/

JobFiles>

On Mac

/Users/<username>

On Linux

Troubleshooting | 41

http://community.netapp.com/t5/forums/postpage/board-id/oncommand-storage-management-software-discussions

/home/<username>(~)

42 |

Copyright information

Copyright © 2018 NetApp, Inc. All rights reserved. Printed in the U.S.

No part of this document covered by copyright may be reproduced in any form or by any means—graphic, electronic, or mechanical, including photocopying, recording, taping, or storage in anelectronic retrieval system—without prior written permission of the copyright owner.

Software derived from copyrighted NetApp material is subject to the following license anddisclaimer:

THIS SOFTWARE IS PROVIDED BY NETAPP "AS IS" AND WITHOUT ANY EXPRESS ORIMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIEDWARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE,WHICH ARE HEREBY DISCLAIMED. IN NO EVENT SHALL NETAPP BE LIABLE FOR ANYDIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIALDAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTEGOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING INANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THEPOSSIBILITY OF SUCH DAMAGE.

NetApp reserves the right to change any products described herein at any time, and without notice.NetApp assumes no responsibility or liability arising from the use of products described herein,except as expressly agreed to in writing by NetApp. The use or purchase of this product does notconvey a license under any patent rights, trademark rights, or any other intellectual property rights ofNetApp.

The product described in this manual may be protected by one or more U.S. patents, foreign patents,or pending applications.

Data contained herein pertains to a commercial item (as defined in FAR 2.101) and is proprietary toNetApp, Inc. The U.S. Government has a non-exclusive, non-transferrable, non-sublicensable,worldwide, limited irrevocable license to use the Data only in connection with and in support of theU.S. Government contract under which the Data was delivered. Except as provided herein, the Datamay not be used, disclosed, reproduced, modified, performed, or displayed without the prior writtenapproval of NetApp, Inc. United States Government license rights for the Department of Defense arelimited to those rights identified in DFARS clause 252.227-7015(b).

43

Trademark information

NETAPP, the NETAPP logo, and the marks listed on the NetApp Trademarks page are trademarks ofNetApp, Inc. Other company and product names may be trademarks of their respective owners.

http://www.netapp.com/us/legal/netapptmlist.aspx

44

http://www.netapp.com/us/legal/netapptmlist.aspx

How to send comments about documentation andreceive update notifications

You can help us to improve the quality of our documentation by sending us your feedback. You canreceive automatic notification when production-level (GA/FCS) documentation is initially released orimportant changes are made to existing production-level documents.

If you have suggestions for improving this document, send us your comments by email.

[email protected]

To help us direct your comments to the correct division, include in the subject line the product name,version, and operating system.

If you want to be notified automatically when production-level documentation is released orimportant changes are made to existing production-level documents, follow Twitter account@NetAppDoc.

You can also contact us in the following ways:

• NetApp, Inc., 1395 Crossman Ave., Sunnyvale, CA 94089 U.S.

• Telephone: +1 (408) 822-6000

• Fax: +1 (408) 822-4501

• Support telephone: +1 (888) 463-8277

45

mailto:[email protected]

Index

A

accessing onecollect amazon machine imageaccessing onecollect ami 20

uploading data to autosupport 35autosupport files

uploading autosupport files 29Basic settings 15

B

backing up database 40

C

collect data 23collecting data from devices and solutions device-basedcollection typesolution-based collection type 7collecting data using snapcenter plug-in

using snapcenter plug-in 28comments

how to send feedback about documentation 45creating user accounts 16

D

data collectionsCollecting data using host performance 27host performance plug-in 27

deploying a onecollect amazon machine image 19deploying onecollect ami 19documentation

how to receive automatic notification of changes to45how to send feedback about 45

E

editing a saved job 32

F

feedbackhow to send comments about documentation 45

H

hosting with nginx

hosting with https 16

I

informationhow to send feedback about improvingdocumentation 45

installing dockerdocker 10

Installing OneCollect 13, 14installing onecollect on windows

installing onecollect on windows using softwarearchive 12

O

OneCollectdata collection 5

ONTAP enabled with multifactor authenticationauthenticating data collected from ONTAP 24

S

scheduling a data collection job 31setting up OneCollect 6suggestions

how to send feedback about documentation 45

T

Twitterhow to receive automatic notification ofdocumentation changes 45

U

uninstalling onecollect 37uninstalling onecollect from a windows host 37uploading host performance data files 29

V

viewing collected dataviewing data of recent job files

viewing data of one job file 33

46 |

onecollect 1.5 installation and setup...

Documents