NetAppDocs Data Collection

You are here:
< All Topics

Please review the following programs and the necessary syntax to collect data from either your NetApp 7-Mode or Clustered Data 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 Windows workstation where these commands are executed and no performance load will occur on your NetApp system.

Requirement & Setup

To use, make sure that your workstation meets the following requirements (click the links to download those items). Please note that both the NetApp Data ONTAP PowerShell Toolkit and NetAppDocs-Lite are updated periodically and that you should always download and use the latest versions:

    • 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 mudule (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.

Your NetApp controller(s) should be running any of the following:

  • Data ONTAP 7.2.x, 7.3.x, 8.0.x (7-Mode), 8.1.x, 8.2.x, 8.3.x, 9.x

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 next command must be entered every time you start a PowerShell instance (non-persistent):

Import-Module NetAppDocs-Lite

DATA Collection

Presuming that the ‘root’ (7-Mode) or ‘admin’ (cDOT) credentials are the same across all systems, the next command will cache the login and store in a variable for use in the data collection. For 7-Mode systems, Active Directory domain credentials can be used, provided that AD authentication has been properly established. If using domain credentials, use the syntax ‘NetBIOS Domain Name\User Name‘ (i.e. – ‘AD\JohnDoe‘).

$Credentials = Get-Credential

The next command will collect data from the systems(s) specified and generate separate compressed XML files for each. This syntax expects the presence of a C:\Output directory. If not present, either create the directory or substitute with the output directory of your choice.

NOTE: If the cluster name(s) does not work then use the cluster management IP address(es). Likewise, for 7-Mode, if the hostname(s) do not work then use the IP address(es) of the controller(s).


Get-NtapFilerData -Name 'controller1', 'controller2', 'controller3', 'controller4' -Credential $Credentials -Verbose | ForEach-Object { $_ | Export-CompressedClixml -Path "C:\Output\$($_.SystemName)_raw.xml" }


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

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

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

Table of Contents