How Can We Help?

Categories

NetAppDocs Data Collection

Created On
Last Updated On
byAndré M. Clark
Print
You are here:
< All Topics

 

 

 

Please review the following procedure and the necessary syntax to collect data from your NetApp ONTAP system(s). The steps provided will generate XML files that can be compressed and uploaded to Red8 to be parsed and have documentation generated. All processing occurs on the workstation where these commands are executed, and no performance load will appear on your NetApp system.

NOTE: Red8 invites you to use the new self-contained NetAppDocs Reports DataCollection utility instead of this manual setup process.

Requirement & Setup

To use, make sure that your workstation meets the following requirements (click the links to download those items).
Please note that NetAppDocs-Lite is updated periodically, and you should always download and use the latest version:

  • Windows:
    • Windows PowerShell 5.1 (with Microsoft .NET Framework 4.7.2+) and PowerShell 7.2+
  • MAC/Linux:
    • PowerShell 7.2+
  • ONTAP: NetApp.ONTAP PowerShell module (included in the install package)

  • NetAppDocs-Lite

    Installation Procedure

    NOTE: If a previous version of the module was installed via the Windows Installer (MSI) package, it is recommended to remove all previous versions using the ‘Apps & features’ or the ‘Add or remove programs’ application in the System Settings area.

    1. Download the latest NetAppDocs-Lite ZIP file.
    2. Unzip the contents to a temporary folder.
    3. Run the .bat script file.

After you have installed the above, and if you are using Windows, run PowerShell in administrator mode (Right-click on PowerShell and select Run as Administrator).
Once in PowerShell, the following command only needs to be entered once (persistent across PowerShell launches):

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned

Respond Yes and proceed. The following command must be entered every time you start a PowerShell instance (non-persistent):

Import-Module NetAppDocs-Lite

Data Collection

If the login credentials are the same across all systems (i.e., “admin”), the following command will cache the credentials and store them in a variable that will be used for the data collection:

$Credentials = Get-Credential

The following command will collect the data from the system(s) specified and generate separate Gzip files for each.
The resulting files will be exported to C:\Output. If it does not exist, either create the directory or substitute it with the output directory of your choosing:

Get-NtapClusterData -Name 'cluster1', 'cluster2', 'cluster3' -Credential $Credentials -Verbose |
  ForEach-Object {
    $_ | Export-CompressedClixml -Path "C:\Output\$($_.SystemName)_raw.xml"
  }

NOTE: Replace cluster1, cluster2, cluster3 with either the fully qualified domain name (FQDN) or IP addresses of the cluster management LIF for each cluster you are collecting data from.

When all data collection is complete, compress and name the file using the syntax yyyymmdd-company-filename.zip.
This is very important as it is the only way Red8 will be able to associate the data collection with your organization.

Once the files are ready, please send them to Red8. You can either email them to
NtapDocsRpts@red8.com or upload them to
Red8 Uploads.

If you have any issues or questions, please feel free to ask.

Table of Contents